Type Aliases Access Access
Control
Policy
: MetadataWithContent & { active
: boolean ; deploymentStatus
: string ; description
?: string | null ; masterLabel
: string ; targetEntity
: string ; version
: number } Access Access: { accessLevel: string ; object: string ; objectField: string ; userField: string }
Type declaration access: string object: string object: string user: string Account Account
Relationship
Share
Rule
: Metadata & { accessLevel
: string ; accountToCriteriaField
: string ; description
?: string | null ; entityType
: string ; masterLabel
: string ; staticFormulaCriteria
?: string | null ; type
: string } Account Account
Settings
: Metadata & { enableAccountHistoryTracking
?: boolean | null ; enableAccountInsightsInMobile
?: boolean | null ; enableAccountOwnerReport
?: boolean | null ; enableAccountTeams
?: boolean | null ; enableContactHistoryTracking
?: boolean | null ; enableRelateContactToMultipleAccounts
?: boolean | null ; showViewHierarchyLink
?: boolean | null } Account Account: { caseAccessLevel: string ; contactAccessLevel: string ; opportunityAccessLevel: string }
Type declaration case: string contact: string opportunity: string Action Action
Link
Group
Template
: Metadata & { actionLinkTemplates
: ActionLinkTemplate [] ; category
: string ; executionsAllowed
: string ; hoursUntilExpiration
?: number | null ; isPublished
: boolean ; name
: string } Action Action: { actionUrl: string ; headers?: string | null ; isConfirmationRequired: boolean ; isGroupDefault: boolean ; label?: string | null ; labelKey: string ; linkType: string ; method: string ; position: number ; requestBody?: string | null ; userAlias?: string | null ; userVisibility: string }
Type declaration action: string Optional headers?: string | null is: boolean is: boolean Optional label?: string | null label: string link: string method: string position: number Optional request?: string | null Optional user?: string | null user: string Action Action: { actionName?: string | null ; comment?: string | null ; content?: string | null ; formFactor?: string | null ; skipRecordTypeSelect?: boolean | null ; type?: string | null }
Type declaration Optional action?: string | null Optional comment?: string | null Optional content?: string | null Optional form?: string | null Optional skip?: boolean | null Optional type?: string | null Action Action
Plan
Template
: Metadata & { actionPlanTemplateItem
: ActionPlanTemplateItem [] ; description
?: string | null ; name
: string ; targetEntityType
: string ; uniqueName
: string } Action Action
Plan
Template
Item
: { actionPlanTemplateItemValue
: ActionPlanTemplateItemValue [] ; displayOrder
?: number | null ; isRequired
?: boolean | null ; name
: string ; uniqueName
: string } Type declaration Optional display?: number | null Optional is?: boolean | null name: string unique: string Action Action: { name: string ; valueFormula?: string | null ; valueLiteral?: string | null }
Type declaration name: string Optional value?: string | null Optional value?: string | null Actions Actions
Settings
: Metadata & { enableDefaultQuickActionsOn
?: boolean | null ; enableMdpEnabled
?: boolean | null ; enableThirdPartyActions
?: boolean | null } Activities Activities
Settings
: Metadata & { allowUsersToRelateMultipleContactsToTasksAndEvents
?: boolean | null ; autoRelateEventAttendees
?: boolean | null ; enableActivityReminders
?: boolean | null ; enableClickCreateEvents
?: boolean | null ; enableDragAndDropScheduling
?: boolean | null ; enableEmailTracking
?: boolean | null ; enableGroupTasks
?: boolean | null ; enableListViewScheduling
?: boolean | null ; enableLogNote
?: boolean | null ; enableMultidayEvents
?: boolean | null ; enableRecurringEvents
?: boolean | null ; enableRecurringTasks
?: boolean | null ; enableRollUpActivToContactsAcct
?: boolean | null ; enableSidebarCalendarShortcut
?: boolean | null ; enableSimpleTaskCreateUI
?: boolean | null ; enableUNSTaskDelegatedToNotifications
?: boolean | null ; enableUserListViewCalendars
?: boolean | null ; meetingRequestsLogo
?: string | null ; showCustomLogoMeetingRequests
?: boolean | null ; showEventDetailsMultiUserCalendar
?: boolean | null ; showHomePageHoverLinksForEvents
?: boolean | null ; showMyTasksHoverLinks
?: boolean | null } Adjustments Adjustments: { enableAdjustments: boolean ; enableOwnerAdjustments: boolean }
Type declaration enable: boolean enable: boolean Agent Agent: { button: string [] }
Agent Agent: { profile: string [] }
Agent Agent: { skill: string [] }
Agent Agent: { user: string [] }
Analytic Analytic
Snapshot
: Metadata & { description
?: string | null ; groupColumn
?: string | null ; mappings
: AnalyticSnapshotMapping [] ; name
: string ; runningUser
?: string | null ; sourceReport
: string ; targetObject
: string } Analytic Analytic: { aggregateType?: string | null ; sourceField: string ; sourceType: string ; targetField: string }
Type declaration Optional aggregate?: string | null source: string source: string target: string Analytics Analytics: { assetType: string ; devName: string ; error?: string | null ; filter?: string | null ; height?: number | null ; hideOnError?: boolean | null ; showHeader?: boolean | null ; showSharing?: boolean | null ; showTitle?: boolean | null ; width?: string | null }
Type declaration asset: string dev: string Optional error?: string | null Optional filter?: string | null Optional height?: number | null Optional hide?: boolean | null Optional show?: boolean | null Optional show?: boolean | null Optional show?: boolean | null Optional width?: string | null Analytics Analytics
Settings
: Metadata & { alwaysGenPreviews
?: boolean | null ; analyticsAdoptionMetadata
?: boolean | null ; canAccessAnalyticsViaAPI
?: boolean | null ; canAnnotateDashboards
?: boolean | null ; canEnableSavedView
?: boolean | null ; canExploreDataConversationally
?: boolean | null ; canShareAppsWithCommunities
?: boolean | null ; canSubscribeDashboardWidgets
?: boolean | null ; canViewThumbnailAssets
?: boolean | null ; enableAnalyticsSubtotals
?: boolean | null ; enableAutoCompleteCombo
?: boolean | null ; enableDashboardComponentSnapshot
?: boolean | null ; enableDashboardFlexiTable
?: boolean | null ; enableEmailReportsToPortalUsers
?: boolean | null ; enableFloatingReportHeaders
?: boolean | null ; enableInsights
?: boolean | null ; enableLightningReportBuilder
?: boolean | null ; enableLotusNotesImages
?: boolean | null ; enableMassEnableReportBuilder
?: boolean | null ; enableNewChartsEngine
?: boolean | null ; enablePowerInsights
?: boolean | null ; enableRemoveFooterForRepDisplay
?: boolean | null ; enableRemoveFooterFromRepExp
?: boolean | null ; enableReportFieldToFieldPref
?: boolean | null ; enableReportUniqueRowCountPref
?: boolean | null ; enableSFXJoinedReportsEnable
?: boolean | null ; enableSmartDataDiscovery
?: boolean | null ; enableUseOldChartsLookAndFeel
?: boolean | null ; enableWaveReplication
?: boolean | null ; enableWaveSharingInheritance
?: boolean | null ; enableWaveTemplate
?: boolean | null ; enableWaveTrendedDatasetCleanup
?: boolean | null } Animation Animation
Rule
: Metadata & { animationFrequency
: string ; developerName
: string ; isActive
: boolean ; masterLabel
: string ; recordTypeContext
: string ; recordTypeName
?: string | null ; sobjectType
: string ; targetField
: string ; targetFieldChangeToValues
: string } Apex Apex
Page
: MetadataWithContent & { apiVersion
: number ; availableInTouch
?: boolean | null ; confirmationTokenRequired
?: boolean | null ; description
?: string | null ; label
: string ; packageVersions
: PackageVersion [] } Apex Apex
Settings
: Metadata & { enableAggregateCodeCoverageOnly
?: boolean | null ; enableApexAccessRightsPref
?: boolean | null ; enableApexApprovalLockUnlock
?: boolean | null ; enableApexCtrlImplicitWithSharingPref
?: boolean | null ; enableApexPropertyGetterPref
?: boolean | null ; enableAuraApexCtrlAuthUserAccessCheckPref
?: boolean | null ; enableAuraApexCtrlGuestUserAccessCheckPref
?: boolean | null ; enableCompileOnDeploy
?: boolean | null ; enableDisableParallelApexTesting
?: boolean | null ; enableDoNotEmailDebugLog
?: boolean | null ; enableGaplessTestAutoNum
?: boolean | null ; enableMngdCtrlActionAccessPref
?: boolean | null ; enableNonCertifiedApexMdCrud
?: boolean | null } Apex Apex
Test
Suite
: Metadata & { testClassName
: string [] } App App: { footerColor?: string | null ; headerColor?: string | null ; logo?: string | null ; logoVersion?: number | null ; shouldOverrideOrgTheme?: boolean | null }
Type declaration Optional footer?: string | null Optional header?: string | null Optional logo?: string | null Optional logo?: number | null Optional should?: boolean | null App App: { alignment: string ; components: string [] }
Type declaration alignment: string components: string [] App App
Experience
Settings
: Metadata & { doesHideAllAppsInAppLauncher
?: boolean | null } App App: { name: string ; type: string }
App App: { enableCustomizeMyTabs: boolean ; enableKeyboardShortcuts: boolean ; enableListViewHover: boolean ; enableListViewReskin: boolean ; enableMultiMonitorComponents: boolean ; enablePinTabs: boolean ; enableTabHover: boolean ; enableTabLimits: boolean ; saveUserSessions: boolean }
Type declaration enable: boolean enable: boolean enable: boolean enable: boolean enable: boolean enable: boolean enable: boolean enable: boolean save: boolean Appointment Appointment
Scheduling
Policy
: Metadata & { appointmentStartTimeInterval
: string ; masterLabel
: string ; shouldConsiderCalendarEvents
: boolean ; shouldEnforceExcludedResource
: boolean ; shouldEnforceRequiredResource
: boolean ; shouldMatchSkill
: boolean ; shouldMatchSkillLevel
: boolean ; shouldRespectVisitingHours
: boolean ; shouldUsePrimaryMembers
: boolean ; shouldUseSecondaryMembers
: boolean } Approval Approval
Entry
Criteria
: { booleanFilter
?: string | null ; criteriaItems
: FilterItem [] ; formula
?: string | null } Type declaration Optional boolean?: string | null Optional formula?: string | null Approval Approval: { field: string [] }
Approval Approval
Process
: Metadata & { active
: boolean ; allowRecall
?: boolean | null ; allowedSubmitters
: ApprovalSubmitter [] ; approvalPageFields
?: ApprovalPageField | null ; approvalStep
: ApprovalStep [] ; description
?: string | null ; emailTemplate
?: string | null ; enableMobileDeviceAccess
?: boolean | null ; entryCriteria
?: ApprovalEntryCriteria | null ; finalApprovalActions
?: ApprovalAction | null ; finalApprovalRecordLock
?: boolean | null ; finalRejectionActions
?: ApprovalAction | null ; finalRejectionRecordLock
?: boolean | null ; initialSubmissionActions
?: ApprovalAction | null ; label
: string ; nextAutomatedApprover
?: NextAutomatedApprover | null ; postTemplate
?: string | null ; recallActions
?: ApprovalAction | null ; recordEditability
: string ; showApprovalHistory
?: boolean | null } Approval Type declaration Optional allow?: boolean | null Optional approval?: ApprovalAction | null Optional description?: string | null Optional if?: string | null label: string name: string Optional rejection?: ApprovalAction | null Approval Approval
Step
Approver
: { approver
: Approver [] ; whenMultipleApprovers
?: string | null } Type declaration Optional when?: string | null Approval Approval: { type: string }
Approval Approval: { submitter?: string | null ; type: string }
Type declaration Optional submitter?: string | null type: string Approver Approver: { name?: string | null ; type: string }
Type declaration Optional name?: string | null type: string Archive Archive
Settings
: Metadata & { enableEntityArchivingEnabled
?: boolean | null } Article Article Article: { channel: string ; page?: string | null ; template: string }
Type declaration channel: string Optional page?: string | null template: string Async Async: { done: boolean ; id: string ; message?: string | null ; state: string ; statusCode?: string | null }
Type declaration done: boolean id: string Optional message?: string | null state: string Optional status?: string | null Attachment Attachment: { content: string ; name: string }
Type declaration content: string name: string Audience Audience: { city?: string | null ; country?: string | null ; domain?: string | null ; entityField?: string | null ; entityType?: string | null ; fieldValue?: string | null ; isEnabled?: string | null ; permissionName?: string | null ; permissionType?: string | null ; profile?: string | null ; subdivision?: string | null }
Type declaration Optional city?: string | null Optional country?: string | null Optional domain?: string | null Optional entity?: string | null Optional entity?: string | null Optional field?: string | null Optional is?: string | null Optional permission?: string | null Optional permission?: string | null Optional profile?: string | null Optional subdivision?: string | null Audience Audience
Criterion
: { criteriaNumber
?: number | null ; criterionValue
?: AudienceCriteriaValue | null ; operator
?: string | null ; type
: string } Type declaration Optional criteria?: number | null Optional operator?: string | null type: string Aura Aura
Definition
Bundle
: Metadata & { SVGContent
?: string | null ; apiVersion
?: number | null ; controllerContent
?: string | null ; description
?: string | null ; designContent
?: string | null ; documentationContent
?: string | null ; helperContent
?: string | null ; markup
?: string | null ; modelContent
?: string | null ; packageVersions
: PackageVersion [] ; rendererContent
?: string | null ; styleContent
?: string | null ; testsuiteContent
?: string | null ; type
?: string | null } Auth Auth
Provider
: Metadata & { appleTeam
?: string | null ; authorizeUrl
?: string | null ; consumerKey
?: string | null ; consumerSecret
?: string | null ; customMetadataTypeRecord
?: string | null ; defaultScopes
?: string | null ; ecKey
?: string | null ; errorUrl
?: string | null ; executionUser
?: string | null ; friendlyName
: string ; iconUrl
?: string | null ; idTokenIssuer
?: string | null ; includeOrgIdInIdentifier
?: boolean | null ; linkKickoffUrl
?: string | null ; logoutUrl
?: string | null ; oauthKickoffUrl
?: string | null ; plugin
?: string | null ; portal
?: string | null ; providerType
: string ; registrationHandler
?: string | null ; sendAccessTokenInHeader
?: boolean | null ; sendClientCredentialsInHeader
?: boolean | null ; sendSecretInApis
?: boolean | null ; ssoKickoffUrl
?: string | null ; tokenUrl
?: string | null ; userInfoUrl
?: string | null } Blockchain Blockchain
Settings
: Metadata & { enableBcp
?: boolean | null ; enableBcpCoin
?: boolean | null } Bot Bot
Dialog
: { botDialogGroup
?: string | null ; botSteps
: BotStep [] ; description
?: string | null ; developerName
: string ; label
: string ; mlIntent
?: string | null ; mlIntentTrainingEnabled
?: boolean | null ; showInFooterMenu
?: boolean | null } Type declaration Optional bot?: string | null Optional description?: string | null developer: string label: string Optional ml?: string | null Optional ml?: boolean | null Optional show?: boolean | null Bot Bot: { description?: string | null ; developerName: string ; label: string }
Type declaration Optional description?: string | null developer: string label: string Bot Bot
Invocation
: { invocationActionName
?: string | null ; invocationActionType
?: string | null ; invocationMappings
: BotInvocationMapping [] } Type declaration Optional invocation?: string | null Optional invocation?: string | null Bot Bot: { parameterName: string ; type: string ; value?: string | null ; variableName?: string | null ; variableType?: string | null }
Type declaration parameter: string type: string Optional value?: string | null Optional variable?: string | null Optional variable?: string | null Bot Bot: { message: string }
Bot Bot: { label?: string | null ; targetBotDialog: string }
Type declaration Optional label?: string | null target: string Bot Bot: { literalValue: string }
Bot Bot
Settings
: Metadata & { enableBots
?: boolean | null } Bot Type declaration Optional boolean?: string | null Optional bot?: BotInvocation | null Optional bot?: BotNavigation | null type: string Bot Bot: { leftOperandName: string ; leftOperandType: string ; operatorType: string ; rightOperandValue?: string | null }
Type declaration left: string left: string operator: string Optional right?: string | null Bot Bot: { disableAutoFill?: boolean | null ; sourceName?: string | null ; sourceType?: string | null ; sourceValue?: string | null ; targetName: string ; targetType: string }
Type declaration Optional disable?: boolean | null Optional source?: string | null Optional source?: string | null Optional source?: string | null target: string target: string Bot Bot
Variable
Operation
: { botInvocation
?: BotInvocation | null ; botMessages
: BotMessage [] ; botQuickReplyOptions
: BotQuickReplyOption [] ; botVariableOperands
: BotVariableOperand [] ; invalidInputBotNavigation
?: BotNavigation | null ; quickReplyOptionTemplate
?: string | null ; quickReplyType
?: string | null ; quickReplyWidgetType
?: string | null ; sourceVariableName
?: string | null ; sourceVariableType
?: string | null ; type
: string } Type declaration Optional bot?: BotInvocation | null Optional invalid?: BotNavigation | null Optional quick?: string | null Optional quick?: string | null Optional quick?: string | null Optional source?: string | null Optional source?: string | null type: string Branding Branding
Set
: Metadata & { brandingSetProperty
: BrandingSetProperty [] ; description
?: string | null ; masterLabel
: string ; type
?: string | null } Branding Branding: { propertyName: string ; propertyValue?: string | null }
Type declaration property: string Optional property?: string | null Business Business
Hours
Entry
: Metadata & { active
?: boolean | null ; default
: boolean ; fridayEndTime
?: string | null ; fridayStartTime
?: string | null ; mondayEndTime
?: string | null ; mondayStartTime
?: string | null ; name
?: string | null ; saturdayEndTime
?: string | null ; saturdayStartTime
?: string | null ; sundayEndTime
?: string | null ; sundayStartTime
?: string | null ; thursdayEndTime
?: string | null ; thursdayStartTime
?: string | null ; timeZoneId
?: string | null ; tuesdayEndTime
?: string | null ; tuesdayStartTime
?: string | null ; wednesdayEndTime
?: string | null ; wednesdayStartTime
?: string | null } Business Business
Process
: Metadata & { description
?: string | null ; isActive
?: boolean | null ; values
: PicklistValue [] } CMSConnect CMSConnect: { assetPath: string ; assetType: string ; sortOrder: number }
Type declaration asset: string asset: string sort: number CMSConnect CMSConnect: { cmsLanguage: string ; language: string }
Type declaration cms: string language: string CMSConnect CMSConnect: { connectorPage: string ; connectorPageAsset: string }
Type declaration connector: string connector: string CMSConnect CMSConnect: { developerName: string ; masterLabel: string ; options: number ; payloadType: string ; resourceIdPath?: string | null ; resourceNamePath?: string | null ; resourcePath: string ; rootNodePath?: string | null }
Type declaration developer: string master: string options: number payload: string Optional resource?: string | null Optional resource?: string | null resource: string Optional root?: string | null CMSConnect CMSConnect
Resource
Type
: { cmsConnectResourceDefinition
: CMSConnectResourceDefinition [] ; developerName
: string ; masterLabel
: string ; resourceType
: string } Type declaration developer: string master: string resource: string CMSConnect CMSConnect
Source
: Metadata & { cmsConnectAsset
: CMSConnectAsset [] ; cmsConnectLanguage
: CMSConnectLanguage [] ; cmsConnectPersonalization
?: CMSConnectPersonalization | null ; cmsConnectResourceType
: CMSConnectResourceType [] ; connectionType
: string ; cssScope
?: string | null ; developerName
: string ; languageEnabled
?: string | null ; masterLabel
: string ; namedCredential
?: string | null ; personalizationEnabled
?: string | null ; rootPath
?: string | null ; sortOrder
: number ; status
: string ; type
: string ; websiteUrl
?: string | null } Call Call
Center
: Metadata & { adapterUrl
?: string | null ; customSettings
?: string | null ; displayName
: string ; displayNameLabel
: string ; internalNameLabel
: string ; sections
: CallCenterSection [] ; version
?: string | null } Call Call: { label: string ; name: string ; value: string }
Type declaration label: string name: string value: string Call Call
Center
Section
: { items
: CallCenterItem [] ; label
: string ; name
: string } Type declaration label: string name: string Campaign Campaign
Influence
Model
: Metadata & { isActive
?: boolean | null ; isDefaultModel
: boolean ; isModelLocked
: boolean ; modelDescription
?: string | null ; name
: string ; recordPreference
?: string | null } Campaign Campaign
Settings
: Metadata & { enableAutoCampInfluenceDisabled
?: boolean | null ; enableB2bmaCampaignInfluence2
?: boolean | null ; enableCampaignHistoryTrackEnabled
?: boolean | null ; enableCampaignInfluence2
?: boolean | null ; enableCampaignMemberTWCF
?: boolean | null ; enableSuppressNoValueCI2
?: boolean | null } Cancel Cancel: { done: boolean ; id: string }
Canvas Canvas
Metadata
: Metadata & { accessMethod
: string ; canvasOptions
?: string | null ; canvasUrl
: string ; lifecycleClass
?: string | null ; locationOptions
?: string | null ; samlInitiationMethod
?: string | null } Case Case
Classification
Settings
: Metadata & { caseClassificationRecommendations
?: boolean | null ; reRunAttributeBasedRules
?: boolean | null ; runAssignmentRules
?: boolean | null } Case Case
Settings
: Metadata & { caseAssignNotificationTemplate
?: string | null ; caseAutoProcUser
?: boolean | null ; caseCloseNotificationTemplate
?: string | null ; caseCommentNotificationTemplate
?: string | null ; caseCreateNotificationTemplate
?: string | null ; caseFeedItemSettings
: FeedItemSettings [] ; caseFeedReadUnreadLtng
?: boolean | null ; caseMergeInLightning
?: boolean | null ; closeCaseThroughStatusChange
?: boolean | null ; defaultCaseFeedLayoutOn
?: boolean | null ; defaultCaseOwner
?: string | null ; defaultCaseOwnerType
?: string | null ; defaultCaseUser
?: string | null ; emailActionDefaultsHandlerClass
?: string | null ; emailToCase
?: EmailToCaseSettings | null ; enableCaseFeed
?: boolean | null ; enableCollapseEmailThread
?: boolean | null ; enableDraftEmails
?: boolean | null ; enableEarlyEscalationRuleTriggers
?: boolean | null ; enableEmailActionDefaultsHandler
?: boolean | null ; enableSuggestedArticlesApplication
?: boolean | null ; enableSuggestedArticlesCustomerPortal
?: boolean | null ; enableSuggestedArticlesPartnerPortal
?: boolean | null ; enableSuggestedSolutions
?: boolean | null ; escalateCaseBefore
?: boolean | null ; genericMessageEnabled
?: boolean | null ; keepRecordTypeOnAssignmentRule
?: boolean | null ; notifyContactOnCaseComment
?: boolean | null ; notifyDefaultCaseOwner
?: boolean | null ; notifyOwnerOnCaseComment
?: boolean | null ; notifyOwnerOnCaseOwnerChange
?: boolean | null ; predictiveSupportEnabled
?: boolean | null ; showEmailAttachmentsInCaseAttachmentsRL
?: boolean | null ; showFewerCloseActions
?: boolean | null ; systemUserEmail
?: string | null ; useSystemEmailAddress
?: boolean | null ; useSystemUserAsDefaultCaseUser
?: boolean | null ; webToCase
?: WebToCaseSettings | null } Case Case
Subject
Particle
: Metadata & { index
: number ; textField
?: string | null ; type
: string } Certificate Certificate
: MetadataWithContent & { caSigned
: boolean ; encryptedWithPlatformEncryption
?: boolean | null ; expirationDate
?: string | null ; keySize
?: number | null ; masterLabel
: string ; privateKeyExportable
?: boolean | null } Channel Channel
Layout
: Metadata & { enabledChannels
: string [] ; label
: string ; layoutItems
: ChannelLayoutItem [] ; recordType
?: string | null } Channel Channel: { field: string }
Chart Chart: { aggregate?: string | null ; axisBinding?: string | null ; column: string }
Type declaration Optional aggregate?: string | null Optional axis?: string | null column: string Chatter Chatter: { name: string ; value: number }
Type declaration name: string value: number Chatter Chatter
Answers
Settings
: Metadata & { emailFollowersOnBestAnswer
?: boolean | null ; emailFollowersOnReply
?: boolean | null ; emailOwnerOnPrivateReply
?: boolean | null ; emailOwnerOnReply
?: boolean | null ; enableAnswerViaEmail
?: boolean | null ; enableChatterAnswers
: boolean ; enableFacebookSSO
?: boolean | null ; enableInlinePublisher
?: boolean | null ; enableReputation
?: boolean | null ; enableRichTextEditor
?: boolean | null ; facebookAuthProvider
?: string | null ; showInPortals
?: boolean | null } Chatter Chatter
EmailsMDSettings
: Metadata & { enableChatterDigestEmailsApiOnly
?: boolean | null ; enableChatterEmailAttachment
?: boolean | null ; enableCollaborationEmail
?: boolean | null ; enableDisplayAppDownloadBadges
?: boolean | null ; enableEmailReplyToChatter
?: boolean | null ; enableEmailToChatter
?: boolean | null } Chatter Chatter
Extension
: Metadata & { compositionComponent
: string ; description
: string ; extensionName
: string ; headerText
?: string | null ; hoverText
?: string | null ; icon
: string ; isProtected
?: boolean | null ; masterLabel
: string ; renderComponent
: string ; type
: string } Chatter Chatter
Settings
: Metadata & { allowChatterGroupArchiving
?: boolean | null ; allowRecordsInChatterGroup
?: boolean | null ; allowSharingInChatterGroup
?: boolean | null ; enableApprovalRequest
?: boolean | null ; enableChatter
?: boolean | null ; enableChatterEmoticons
?: boolean | null ; enableFeedEdit
?: boolean | null ; enableFeedPinning
?: boolean | null ; enableFeedsDraftPosts
?: boolean | null ; enableFeedsRichText
?: boolean | null ; enableInviteCsnUsers
?: boolean | null ; enableOutOfOfficeEnabledPref
?: boolean | null ; enableRichLinkPreviewsInFeed
?: boolean | null ; enableTodayRecsInFeed
?: boolean | null ; unlistedGroupsEnabled
?: boolean | null } Clean Clean
Data
Service
: Metadata & { cleanRules
: CleanRule [] ; description
: string ; masterLabel
: string ; matchEngine
: string } Clean Clean
Rule
: { bulkEnabled
: boolean ; bypassTriggers
: boolean ; bypassWorkflow
: boolean ; description
: string ; developerName
: string ; fieldMappings
: FieldMapping [] ; masterLabel
: string ; matchRule
: string ; sourceSobjectType
: string ; status
: string ; targetSobjectType
: string } Type declaration bulk: boolean bypass: boolean bypass: boolean description: string developer: string master: string match: string source: string status: string target: string Code Type declaration id: string name: string Optional namespace?: string | null num: number num: number type: string Code Code: { id: string ; message: string ; name?: string | null ; namespace?: string | null }
Type declaration id: string message: string Optional name?: string | null Optional namespace?: string | null Code Code: { column: number ; line: number ; numExecutions: number ; time: number }
Type declaration column: number line: number num: number time: number Command Command: { defaultValue?: string | null ; description?: string | null ; name: string ; required?: boolean | null ; type: string }
Type declaration Optional default?: string | null Optional description?: string | null name: string Optional required?: boolean | null type: string Command Command: { template: string }
Communities Communities
Settings
: Metadata & { canModerateAllFeedPosts
?: boolean | null ; canModerateInternalFeedPosts
?: boolean | null ; embeddedVisualforcePages
?: boolean | null ; enableCommunityWorkspaces
?: boolean | null ; enableCspContactVisibilityPref
?: boolean | null ; enableCspNotesOnAccConPref
?: boolean | null ; enableEnablePRM
?: boolean | null ; enableExternalAccHierPref
?: boolean | null ; enableGuestRecordReassignOrgPref
?: boolean | null ; enableInviteChatterGuestEnabled
?: boolean | null ; enableNetPortalUserReportOpts
?: boolean | null ; enableNetworksEnabled
?: boolean | null ; enableOotbProfExtUserOpsEnable
?: boolean | null ; enablePRMAccRelPref
?: boolean | null ; enablePowerCustomerCaseStatus
?: boolean | null ; enableRelaxPartnerAccountFieldPref
?: boolean | null ; enableUsernameUniqForOrgPref
?: boolean | null } Community Community
: Metadata & { active
?: boolean | null ; chatterAnswersFacebookSsoUrl
?: string | null ; communityFeedPage
?: string | null ; dataCategoryName
?: string | null ; description
?: string | null ; emailFooterDocument
?: string | null ; emailHeaderDocument
?: string | null ; emailNotificationUrl
?: string | null ; enableChatterAnswers
?: boolean | null ; enablePrivateQuestions
?: boolean | null ; expertsGroup
?: string | null ; portal
?: string | null ; reputationLevels
?: ReputationLevels | null ; showInPortal
?: boolean | null ; site
?: string | null } Community Community: { description?: string | null ; label: string }
Type declaration Optional description?: string | null label: string Community Community: { customerUserRole?: string | null ; employeeUserRole?: string | null ; partnerUserRole?: string | null }
Type declaration Optional customer?: string | null Optional employee?: string | null Optional partner?: string | null Community Community: { description?: string | null ; image?: string | null ; order: number ; title: string ; type: string }
Type declaration Optional description?: string | null Optional image?: string | null order: number title: string type: string Community Community
Template
Definition
: Metadata & { baseTemplate
?: string | null ; bundlesInfo
: CommunityTemplateBundleInfo [] ; category
: string ; defaultBrandingSet
?: string | null ; defaultThemeDefinition
: string ; description
?: string | null ; enableExtendedCleanUpOnDelete
?: boolean | null ; masterLabel
: string ; navigationLinkSet
: NavigationLinkSet [] ; pageSetting
: CommunityTemplatePageSetting [] ; publisher
?: string | null } Community Community: { page: string ; themeLayout: string }
Type declaration page: string theme: string Community Community: { customThemeLayoutType?: string | null ; pageAttributes: string ; pageType: string ; themeLayoutType?: string | null }
Type declaration Optional custom?: string | null page: string page: string Optional theme?: string | null Community Community: { customThemeLayoutType?: string | null ; themeLayout: string ; themeLayoutType?: string | null }
Type declaration Optional custom?: string | null theme: string Optional theme?: string | null Compact Compact
Layout
: Metadata & { fields
: string [] ; label
: string } Component Type declaration component: string Optional visibility?: UiFormulaRule | null Component Component: { name?: string | null ; type?: string | null ; value?: string | null }
Type declaration Optional name?: string | null Optional type?: string | null Optional value?: string | null Connected Connected: { formula: string ; key: string }
Type declaration formula: string key: string Connected Connected: { accessMethod: string ; canvasUrl: string ; lifecycleClass?: string | null ; locations: string [] ; options: string [] ; samlInitiationMethod?: string | null }
Type declaration access: string canvas: string Optional lifecycle?: string | null locations: string [] options: string [] Optional saml?: string | null Connected Connected: { description?: string | null ; end: string ; start: string }
Type declaration Optional description?: string | null end: string start: string Connected Connected: { applicationBinaryFile?: string | null ; applicationBinaryFileName?: string | null ; applicationBundleIdentifier?: string | null ; applicationFileLength?: number | null ; applicationIconFile?: string | null ; applicationIconFileName?: string | null ; applicationInstallUrl?: string | null ; devicePlatform: string ; deviceType?: string | null ; minimumOsVersion?: string | null ; privateApp?: boolean | null ; version: string }
Type declaration Optional application?: string | null Optional application?: string | null Optional application?: string | null Optional application?: number | null Optional application?: string | null Optional application?: string | null Optional application?: string | null device: string Optional device?: string | null Optional minimum?: string | null Optional private?: boolean | null version: string Connected Connected
App
Oauth
Config
: { callbackUrl
: string ; certificate
?: string | null ; consumerKey
?: string | null ; consumerSecret
?: string | null ; idTokenConfig
?: ConnectedAppOauthIdToken | null ; isAdminApproved
?: boolean | null ; scopes
: string [] ; singleLogoutUrl
?: string | null } Type declaration callback: string Optional certificate?: string | null Optional consumer?: string | null Optional consumer?: string | null Optional is?: boolean | null scopes: string [] Optional single?: string | null Connected Connected: { idTokenAudience?: string | null ; idTokenIncludeAttributes?: boolean | null ; idTokenIncludeCustomPerms?: boolean | null ; idTokenIncludeStandardClaims?: boolean | null ; idTokenValidity?: number | null }
Type declaration Optional id?: string | null Optional id?: boolean | null Optional id?: boolean | null Optional id?: boolean | null Optional id?: number | null Connected Connected: { acsUrl: string ; certificate?: string | null ; encryptionCertificate?: string | null ; encryptionType?: string | null ; entityUrl: string ; issuer?: string | null ; samlIdpSLOBindingEnum?: string | null ; samlNameIdFormat?: string | null ; samlSloUrl?: string | null ; samlSubjectCustomAttr?: string | null ; samlSubjectType: string }
Type declaration acs: string Optional certificate?: string | null Optional encryption?: string | null Optional encryption?: string | null entity: string Optional issuer?: string | null Optional saml?: string | null Optional saml?: string | null Optional saml?: string | null Optional saml?: string | null saml: string Connected Connected
App
Settings
: Metadata & { enableAdminApprovedAppsOnly
?: boolean | null ; enableSkipUserProvisioningWizardWelcomePage
?: boolean | null } Container Container
: { height
?: number | null ; isContainerAutoSizeEnabled
: boolean ; region
: string ; sidebarComponents
: SidebarComponent [] ; style
: string ; unit
: string ; width
?: number | null } Type declaration Optional height?: number | null is: boolean region: string style: string unit: string Optional width?: number | null Content Content: { access: string ; isManagingWorkspace?: boolean | null ; name?: string | null }
Type declaration access: string Optional is?: boolean | null Optional name?: string | null Content Content Content: { number: string ; pathOnClient: string ; zipEntry?: string | null }
Type declaration number: string path: string Optional zip?: string | null Content Content
Settings
: Metadata & { enableChatterFileLink
?: boolean | null ; enableContent
?: boolean | null ; enableContentAutoAssign
?: boolean | null ; enableContentDistForPortalUsers
?: boolean | null ; enableContentDistPwOptionsBit1
?: boolean | null ; enableContentDistPwOptionsBit2
?: boolean | null ; enableContentDistribution
?: boolean | null ; enableContentSupportMultiLanguage
?: boolean | null ; enableContentWorkspaceAccess
?: boolean | null ; enableFileShareSetByRecord
?: boolean | null ; enableFilesUsrShareNetRestricted
?: boolean | null ; enableJPGPreviews
?: boolean | null ; enableLibraryManagedFiles
?: boolean | null ; enableSiteGuestUserToUploadFiles
?: boolean | null ; enableUploadFilesOnAttachments
?: boolean | null ; skipContentAssetTriggers
?: boolean | null ; skipContentAssetTriggersOnDeploy
?: boolean | null } Contract Contract
Settings
: Metadata & { autoCalculateEndDate
?: boolean | null ; autoExpirationDelay
?: string | null ; autoExpirationRecipient
?: string | null ; autoExpireContracts
?: boolean | null ; enableContractHistoryTracking
?: boolean | null ; notifyOwnersOnContractExpiration
?: boolean | null } Conversation Conversation
Context
Variable
: { SObjectType
?: string | null ; contextVariableMappings
: ConversationContextVariableMapping [] ; dataType
: string ; developerName
: string ; label
: string } Type declaration Optional SObject?: string | null data: string developer: string label: string Conversation Conversation: { SObjectType: string ; fieldName: string ; messageType: string }
Type declaration SObject: string field: string message: string Conversation Conversation
Record
Lookup
: { SObjectType
: string ; lookupFields
: ConversationRecordLookupField [] ; maxLookupResults
: number ; sourceVariableName
: string ; sourceVariableType
: string ; targetVariableName
: string } Type declaration SObject: string max: number source: string source: string target: string Conversation Conversation: { fieldName: string }
Conversation Conversation Conversation: { mappingType: string ; parameterType: string ; variableName: string }
Type declaration mapping: string parameter: string variable: string Conversation Conversation: { SObjectType?: string | null ; collectionType?: string | null ; dataType: string ; developerName: string ; label: string }
Type declaration Optional SObject?: string | null Optional collection?: string | null data: string developer: string label: string Cors Cors
Whitelist
Origin
: Metadata & { urlPattern
: string } Countries Countries
And
States
: { countries
: Country [] } Country Country
: { active
: boolean ; integrationValue
: string ; isoCode
: string ; label
: string ; orgDefault
: boolean ; standard
: boolean ; states
: State [] ; visible
: boolean } Type declaration active: boolean integration: string iso: string label: string org: boolean standard: boolean visible: boolean Csp Csp
Trusted
Site
: Metadata & { context
?: string | null ; description
?: string | null ; endpointUrl
: string ; isActive
: boolean } Currency Currency
Settings
: Metadata & { enableCurrencyEffectiveDates
?: boolean | null ; enableCurrencySymbolWithMultiCurrency
?: boolean | null ; enableMultiCurrency
?: boolean | null ; isMultiCurrencyActivationAllowed
?: boolean | null ; isParenCurrencyConvDisabled
?: boolean | null } Custom Custom
Application
: Metadata & { actionOverrides
: AppActionOverride [] ; brand
?: AppBrand | null ; consoleConfig
?: ServiceCloudConsoleConfig | null ; defaultLandingTab
?: string | null ; description
?: string | null ; formFactors
: string [] ; isNavAutoTempTabsDisabled
?: boolean | null ; isNavPersonalizationDisabled
?: boolean | null ; isServiceCloudConsole
?: boolean | null ; label
?: string | null ; logo
?: string | null ; navType
?: string | null ; preferences
?: AppPreferences | null ; profileActionOverrides
: AppProfileActionOverride [] ; setupExperience
?: string | null ; subscriberTabs
: string [] ; tabs
: string [] ; uiType
?: string | null ; utilityBar
?: string | null ; workspaceConfig
?: AppWorkspaceConfig | null } Custom Custom
Application
Component
: Metadata & { buttonIconUrl
?: string | null ; buttonStyle
?: string | null ; buttonText
?: string | null ; buttonWidth
?: number | null ; height
?: number | null ; isHeightFixed
: boolean ; isHidden
: boolean ; isWidthFixed
: boolean ; visualforcePage
: string ; width
?: number | null } Custom Custom: { label: string ; name: string }
Type declaration label: string name: string Custom Custom: { developerSuffix: string ; label?: string | null }
Type declaration developer: string Optional label?: string | null Custom Type declaration custom: string Optional description?: string | null Optional label?: string | null Custom Custom
Feed
Filter
: Metadata & { criteria
: FeedFilterCriterion [] ; description
?: string | null ; isProtected
?: boolean | null ; label
: string } Custom Custom
Field
: Metadata & { businessOwnerGroup
?: string | null ; businessOwnerUser
?: string | null ; businessStatus
?: string | null ; caseSensitive
?: boolean | null ; complianceGroup
?: string | null ; customDataType
?: string | null ; defaultValue
?: string | null ; deleteConstraint
?: string | null ; deprecated
?: boolean | null ; description
?: string | null ; displayFormat
?: string | null ; encryptionScheme
?: string | null ; escapeMarkup
?: boolean | null ; externalDeveloperName
?: string | null ; externalId
?: boolean | null ; fieldManageability
?: string | null ; formula
?: string | null ; formulaTreatBlanksAs
?: string | null ; inlineHelpText
?: string | null ; isAIPredictionField
?: boolean | null ; isConvertLeadDisabled
?: boolean | null ; isFilteringDisabled
?: boolean | null ; isNameField
?: boolean | null ; isSortingDisabled
?: boolean | null ; label
?: string | null ; length
?: number | null ; lookupFilter
?: LookupFilter | null ; maskChar
?: string | null ; maskType
?: string | null ; metadataRelationshipControllingField
?: string | null ; populateExistingRows
?: boolean | null ; precision
?: number | null ; referenceTargetField
?: string | null ; referenceTo
?: string | null ; relationshipLabel
?: string | null ; relationshipName
?: string | null ; relationshipOrder
?: number | null ; reparentableMasterDetail
?: boolean | null ; required
?: boolean | null ; restrictedAdminField
?: boolean | null ; scale
?: number | null ; securityClassification
?: string | null ; startingNumber
?: number | null ; stripMarkup
?: boolean | null ; summarizedField
?: string | null ; summaryFilterItems
: FilterItem [] ; summaryForeignKey
?: string | null ; summaryOperation
?: string | null ; trackFeedHistory
?: boolean | null ; trackHistory
?: boolean | null ; trackTrending
?: boolean | null ; translateData
?: boolean | null ; type
?: string | null ; unique
?: boolean | null ; valueSet
?: ValueSet | null ; visibleLines
?: number | null ; writeRequiresMasterRead
?: boolean | null } Custom Type declaration Optional gender?: string | null Optional help?: string | null Optional label?: string | null name: string Optional relationship?: string | null Optional starts?: string | null Custom Custom: { linkUrl: string ; masterLabel: string ; sortOrder: number }
Type declaration link: string master: string sort: number Custom Custom: { description?: string | null ; headerFieldName: string ; headerFieldValue: string ; isActive?: boolean | null }
Type declaration Optional description?: string | null header: string header: string Optional is?: boolean | null Custom Custom
Label
: Metadata & { categories
?: string | null ; language
: string ; protected
: boolean ; shortDescription
: string ; value
: string } Custom Custom: { label: string ; name: string }
Type declaration label: string name: string Custom Custom
Metadata
: Metadata & { description
?: string | null ; label
?: string | null ; protected
?: boolean | null ; values
: CustomMetadataValue [] } Custom Custom: { field: string ; value?: any | null }
Type declaration field: string Optional value?: any | null Custom Custom
Notification
Type
: Metadata & { customNotifTypeName
: string ; description
?: string | null ; desktop
: boolean ; masterLabel
: string ; mobile
: boolean } Custom Custom
Object
: Metadata & { actionOverrides
: ActionOverride [] ; allowInChatterGroups
?: boolean | null ; articleTypeChannelDisplay
?: ArticleTypeChannelDisplay | null ; businessProcesses
: BusinessProcess [] ; compactLayoutAssignment
?: string | null ; compactLayouts
: CompactLayout [] ; customHelp
?: string | null ; customHelpPage
?: string | null ; customSettingsType
?: string | null ; deploymentStatus
?: string | null ; deprecated
?: boolean | null ; description
?: string | null ; enableActivities
?: boolean | null ; enableBulkApi
?: boolean | null ; enableDataTranslation
?: boolean | null ; enableDivisions
?: boolean | null ; enableEnhancedLookup
?: boolean | null ; enableFeeds
?: boolean | null ; enableHistory
?: boolean | null ; enableLicensing
?: boolean | null ; enableReports
?: boolean | null ; enableSearch
?: boolean | null ; enableSharing
?: boolean | null ; enableStreamingApi
?: boolean | null ; eventType
?: string | null ; externalDataSource
?: string | null ; externalName
?: string | null ; externalRepository
?: string | null ; externalSharingModel
?: string | null ; fieldSets
: FieldSet [] ; fields
: CustomField [] ; gender
?: string | null ; historyRetentionPolicy
?: HistoryRetentionPolicy | null ; household
?: boolean | null ; indexes
: Index [] ; label
?: string | null ; listViews
: ListView [] ; nameField
?: CustomField | null ; pluralLabel
?: string | null ; profileSearchLayouts
: ProfileSearchLayouts [] ; publishBehavior
?: string | null ; recordTypeTrackFeedHistory
?: boolean | null ; recordTypeTrackHistory
?: boolean | null ; recordTypes
: RecordType [] ; searchLayouts
?: SearchLayouts | null ; sharingModel
?: string | null ; sharingReasons
: SharingReason [] ; sharingRecalculations
: SharingRecalculation [] ; startsWith
?: string | null ; validationRules
: ValidationRule [] ; visibility
?: string | null ; webLinks
: WebLink [] } Custom Custom
Page
Web
Link
: Metadata & { availability
: string ; description
?: string | null ; displayType
: string ; encodingKey
?: string | null ; hasMenubar
?: boolean | null ; hasScrollbars
?: boolean | null ; hasToolbar
?: boolean | null ; height
?: number | null ; isResizable
?: boolean | null ; linkType
: string ; masterLabel
?: string | null ; openType
: string ; page
?: string | null ; position
?: string | null ; protected
: boolean ; requireRowSelection
?: boolean | null ; scontrol
?: string | null ; showsLocation
?: boolean | null ; showsStatus
?: boolean | null ; url
?: string | null ; width
?: number | null } Custom Custom: { label: string ; name: string }
Type declaration label: string name: string Custom Custom: { customPermission: string ; dependency: boolean }
Type declaration custom: string dependency: boolean Custom Custom
Shortcut
: DefaultShortcut & { description
?: string | null ; eventName
: string } Custom Custom
Site
: Metadata & { active
: boolean ; allowHomePage
: boolean ; allowStandardAnswersPages
?: boolean | null ; allowStandardIdeasPages
: boolean ; allowStandardLookups
: boolean ; allowStandardPortalPages
: boolean ; allowStandardSearch
: boolean ; analyticsTrackingCode
?: string | null ; authorizationRequiredPage
?: string | null ; bandwidthExceededPage
?: string | null ; browserXssProtection
: boolean ; changePasswordPage
?: string | null ; chatterAnswersForgotPasswordConfirmPage
?: string | null ; chatterAnswersForgotPasswordPage
?: string | null ; chatterAnswersHelpPage
?: string | null ; chatterAnswersLoginPage
?: string | null ; chatterAnswersRegistrationPage
?: string | null ; clickjackProtectionLevel
: string ; contentSniffingProtection
: boolean ; cspUpgradeInsecureRequests
: boolean ; customWebAddresses
: SiteWebAddress [] ; description
?: string | null ; enableAuraRequests
?: boolean | null ; favoriteIcon
?: string | null ; fileNotFoundPage
?: string | null ; forgotPasswordPage
?: string | null ; genericErrorPage
?: string | null ; guestProfile
?: string | null ; inMaintenancePage
?: string | null ; inactiveIndexPage
?: string | null ; indexPage
: string ; masterLabel
: string ; myProfilePage
?: string | null ; portal
?: string | null ; referrerPolicyOriginWhenCrossOrigin
: boolean ; requireHttps
: boolean ; requireInsecurePortalAccess
: boolean ; robotsTxtPage
?: string | null ; rootComponent
?: string | null ; selfRegPage
?: string | null ; serverIsDown
?: string | null ; siteAdmin
?: string | null ; siteRedirectMappings
: SiteRedirectMapping [] ; siteTemplate
?: string | null ; siteType
: string ; subdomain
?: string | null ; urlPathPrefix
?: string | null } Custom Custom
Tab
: Metadata & { actionOverrides
: ActionOverride [] ; auraComponent
?: string | null ; customObject
?: boolean | null ; description
?: string | null ; flexiPage
?: string | null ; frameHeight
?: number | null ; hasSidebar
?: boolean | null ; icon
?: string | null ; label
?: string | null ; lwcComponent
?: string | null ; motif
?: string | null ; page
?: string | null ; scontrol
?: string | null ; splashPageLink
?: string | null ; url
?: string | null ; urlEncodingKey
?: string | null } Custom Custom: { label: string ; name: string }
Type declaration label: string name: string Custom Custom
Value
: Metadata & { color
?: string | null ; default
: boolean ; description
?: string | null ; isActive
?: boolean | null ; label
?: string | null } Dashboard Dashboard
: Metadata & { backgroundEndColor
: string ; backgroundFadeDirection
: string ; backgroundStartColor
: string ; chartTheme
?: string | null ; colorPalette
?: string | null ; dashboardChartTheme
?: string | null ; dashboardColorPalette
?: string | null ; dashboardFilters
: DashboardFilter [] ; dashboardGridLayout
?: DashboardGridLayout | null ; dashboardResultRefreshedDate
?: string | null ; dashboardResultRunningUser
?: string | null ; dashboardType
?: string | null ; description
?: string | null ; folderName
?: string | null ; isGridLayout
?: boolean | null ; leftSection
?: DashboardComponentSection | null ; middleSection
?: DashboardComponentSection | null ; numSubscriptions
?: number | null ; rightSection
?: DashboardComponentSection | null ; runningUser
?: string | null ; textColor
: string ; title
: string ; titleColor
: string ; titleSize
: number } Dashboard Dashboard
Component
: { autoselectColumnsFromReport
?: boolean | null ; chartAxisRange
?: string | null ; chartAxisRangeMax
?: number | null ; chartAxisRangeMin
?: number | null ; chartSummary
: ChartSummary [] ; componentChartTheme
?: string | null ; componentType
: string ; dashboardFilterColumns
: DashboardFilterColumn [] ; dashboardTableColumn
: DashboardTableColumn [] ; decimalPrecision
?: number | null ; displayUnits
?: string | null ; drillDownUrl
?: string | null ; drillEnabled
?: boolean | null ; drillToDetailEnabled
?: boolean | null ; enableHover
?: boolean | null ; expandOthers
?: boolean | null ; flexComponentProperties
?: DashboardFlexTableComponentProperties | null ; footer
?: string | null ; gaugeMax
?: number | null ; gaugeMin
?: number | null ; groupingColumn
: string [] ; groupingSortProperties
?: DashboardComponentGroupingSortProperties | null ; header
?: string | null ; indicatorBreakpoint1
?: number | null ; indicatorBreakpoint2
?: number | null ; indicatorHighColor
?: string | null ; indicatorLowColor
?: string | null ; indicatorMiddleColor
?: string | null ; legendPosition
?: string | null ; maxValuesDisplayed
?: number | null ; metricLabel
?: string | null ; page
?: string | null ; pageHeightInPixels
?: number | null ; report
?: string | null ; scontrol
?: string | null ; scontrolHeightInPixels
?: number | null ; showPercentage
?: boolean | null ; showPicturesOnCharts
?: boolean | null ; showPicturesOnTables
?: boolean | null ; showRange
?: boolean | null ; showTotal
?: boolean | null ; showValues
?: boolean | null ; sortBy
?: string | null ; title
?: string | null ; useReportChart
?: boolean | null } Type declaration Optional autoselect?: boolean | null Optional chart?: string | null Optional chart?: number | null Optional chart?: number | null Optional component?: string | null component: string Optional decimal?: number | null Optional display?: string | null Optional drill?: string | null Optional drill?: boolean | null Optional drill?: boolean | null Optional enable?: boolean | null Optional expand?: boolean | null Optional footer?: string | null Optional gauge?: number | null Optional gauge?: number | null grouping: string [] Optional header?: string | null Optional indicator?: number | null Optional indicator?: number | null Optional indicator?: string | null Optional indicator?: string | null Optional indicator?: string | null Optional legend?: string | null Optional max?: number | null Optional metric?: string | null Optional page?: string | null Optional page?: number | null Optional report?: string | null Optional scontrol?: string | null Optional scontrol?: number | null Optional show?: boolean | null Optional show?: boolean | null Optional show?: boolean | null Optional show?: boolean | null Optional show?: boolean | null Optional show?: boolean | null Optional sort?: string | null Optional title?: string | null Optional use?: boolean | null Dashboard Dashboard: { breakPoint1?: number | null ; breakPoint2?: number | null ; breakPointOrder?: number | null ; highRangeColor?: number | null ; lowRangeColor?: number | null ; midRangeColor?: number | null ; reportColumn: string ; showSubTotal?: boolean | null ; showTotal?: boolean | null ; type: string }
Type declaration Optional break?: number | null Optional break?: number | null Optional break?: number | null Optional high?: number | null Optional low?: number | null Optional mid?: number | null report: string Optional show?: boolean | null Optional show?: boolean | null type: string Dashboard Dashboard: { groupingLevel: string ; inheritedReportGroupingSort?: string | null ; sortColumn?: string | null ; sortOrder?: string | null }
Type declaration grouping: string Optional inherited?: string | null Optional sort?: string | null Optional sort?: string | null Dashboard Dashboard Dashboard Dashboard: { sortColumn?: string | null ; sortOrder?: string | null }
Type declaration Optional sort?: string | null Optional sort?: string | null Dashboard Dashboard: { column: string }
Dashboard Dashboard: { operator: string ; values: string [] }
Type declaration operator: string values: string [] Dashboard Type declaration Optional decimal?: number | null Optional hide?: boolean | null Dashboard Dashboard
Grid
Component
: { colSpan
: number ; columnIndex
: number ; dashboardComponent
: DashboardComponent ; rowIndex
: number ; rowSpan
: number } Type declaration col: number column: number row: number row: number Dashboard Dashboard
Grid
Layout
: { dashboardGridComponents
: DashboardGridComponent [] ; numberOfColumns
: number ; rowHeight
: number } Type declaration number: number row: number Dashboard Dashboard: { enableDashboardIPadApp?: boolean | null }
Type declaration Optional enable?: boolean | null Dashboard Dashboard: { aggregateType?: string | null ; calculatePercent?: boolean | null ; column: string ; decimalPlaces?: number | null ; showSubTotal?: boolean | null ; showTotal?: boolean | null ; sortBy?: string | null }
Type declaration Optional aggregate?: string | null Optional calculate?: boolean | null column: string Optional decimal?: number | null Optional show?: boolean | null Optional show?: boolean | null Optional sort?: string | null Data Data
Category
: { dataCategory
: DataCategory [] ; label
: string ; name
: string } Type declaration label: string name: string Data Data
Category
Group
: Metadata & { active
: boolean ; dataCategory
: DataCategory ; description
?: string | null ; label
: string ; objectUsage
?: ObjectUsage | null } Data Data
Dot
Com
Settings
: Metadata & { enableAccountExportButtonOff
?: boolean | null ; enableAccountImportButtonOff
?: boolean | null ; enableAllowDupeContactFromLead
?: boolean | null ; enableAllowDupeLeadFromContact
?: boolean | null ; enableCleanUpgradeRequested
?: boolean | null ; enableContactExportButtonOff
?: boolean | null ; enableContactImportButtonOff
?: boolean | null } Default Default: { action: string ; active: boolean ; keyCommand: string }
Type declaration action: string active: boolean key: string Delegate Delegate
Group
: Metadata & { customObjects
: string [] ; groups
: string [] ; label
: string ; loginAccess
: boolean ; permissionSets
: string [] ; profiles
: string [] ; roles
: string [] } Delete Delete
Result
: { errors
: Error [] ; fullName
: string ; success
: boolean } Type declaration full: string success: boolean Deploy Deploy: { changed: boolean ; columnNumber?: number | null ; componentType?: string | null ; created: boolean ; createdDate: string ; deleted: boolean ; fileName: string ; fullName: string ; id?: string | null ; lineNumber?: number | null ; problem?: string | null ; problemType?: string | null ; success: boolean }
Type declaration changed: boolean Optional column?: number | null Optional component?: string | null created: boolean created: string deleted: boolean file: string full: string Optional id?: string | null Optional line?: number | null Optional problem?: string | null Optional problem?: string | null success: boolean Deploy Deploy: { allowMissingFiles: boolean ; autoUpdatePackage: boolean ; checkOnly: boolean ; ignoreWarnings: boolean ; performRetrieve: boolean ; purgeOnDelete: boolean ; rollbackOnError: boolean ; runTests: string [] ; singlePackage: boolean ; testLevel: string }
Type declaration allow: boolean auto: boolean check: boolean ignore: boolean perform: boolean purge: boolean rollback: boolean run: string [] single: boolean test: string Deploy Deploy
Result
: { canceledBy
?: string | null ; canceledByName
?: string | null ; checkOnly
: boolean ; completedDate
?: string | null ; createdBy
: string ; createdByName
: string ; createdDate
: string ; details
: DeployDetails ; done
: boolean ; errorMessage
?: string | null ; errorStatusCode
?: string | null ; id
: string ; ignoreWarnings
: boolean ; lastModifiedDate
?: string | null ; numberComponentErrors
: number ; numberComponentsDeployed
: number ; numberComponentsTotal
: number ; numberTestErrors
: number ; numberTestsCompleted
: number ; numberTestsTotal
: number ; rollbackOnError
: boolean ; runTestsEnabled
: boolean ; startDate
?: string | null ; stateDetail
?: string | null ; status
: string ; success
: boolean } Type declaration Optional canceled?: string | null Optional canceled?: string | null check: boolean Optional completed?: string | null created: string created: string created: string done: boolean Optional error?: string | null Optional error?: string | null id: string ignore: boolean Optional last?: string | null number: number number: number number: number number: number number: number number: number rollback: boolean run: boolean Optional start?: string | null Optional state?: string | null status: string success: boolean Deployment Deployment
Settings
: Metadata & { doesSkipAsyncApexValidation
?: boolean | null } Describe Describe: { childXmlNames: string [] ; directoryName: string ; inFolder: boolean ; metaFile: boolean ; suffix?: string | null ; xmlName: string }
Type declaration child: string [] directory: string in: boolean meta: boolean Optional suffix?: string | null xml: string Describe Describe
Metadata
Result
: { metadataObjects
: DescribeMetadataObject [] ; organizationNamespace
: string ; partialSaveAllowed
: boolean ; testRequired
: boolean } Type declaration organization: string partial: boolean test: boolean Describe Describe
Value
Type
Result
: { apiCreatable
: boolean ; apiDeletable
: boolean ; apiReadable
: boolean ; apiUpdatable
: boolean ; parentField
?: ValueTypeField | null ; valueTypeFields
: ValueTypeField [] } Type declaration api: boolean api: boolean api: boolean api: boolean Optional parent?: ValueTypeField | null Dev Dev
Hub
Settings
: Metadata & { enableShapeExportPref
?: boolean | null } Discovery Discovery
Settings
: Metadata & { enableEinsteinAnswersPref
?: boolean | null } Document Document
: MetadataWithContent & { description
?: string | null ; internalUseOnly
: boolean ; keywords
?: string | null ; name
?: string | null ; public
: boolean } Document Document
Type
: Metadata & { description
: string ; isActive
: boolean ; masterLabel
: string } Duplicate Duplicate
Rule
: Metadata & { actionOnInsert
: string ; actionOnUpdate
: string ; alertText
?: string | null ; description
?: string | null ; duplicateRuleFilter
?: DuplicateRuleFilter | null ; duplicateRuleMatchRules
?: DuplicateRuleMatchRule [] | null ; isActive
: boolean ; masterLabel
: string ; operationsOnInsert
: string [] ; operationsOnUpdate
: string [] ; securityOption
: string ; sortOrder
: number } Duplicate Type declaration Optional boolean?: string | null Duplicate Duplicate
Rule
Filter
Item
: FilterItem & { sortOrder
: number ; table
: string } Duplicate Duplicate
Rule
Match
Rule
: { matchRuleSObjectType
: string ; matchingRule
: string ; objectMapping
?: ObjectMapping | null } Type declaration match: string matching: string Optional object?: ObjectMapping | null EACSettings EACSettings
: Metadata & { enableEACForEveryonePref
?: boolean | null ; enableInboxActivitySharing
?: boolean | null ; enableInsightsInTimeline
?: boolean | null ; enableInsightsInTimelineEacStd
?: boolean | null } Eclair Eclair: { boundingBoxBottom?: number | null ; boundingBoxLeft?: number | null ; boundingBoxRight?: number | null ; boundingBoxTop?: number | null ; mapLabel?: string | null ; mapName: string ; projection: string }
Type declaration Optional bounding?: number | null Optional bounding?: number | null Optional bounding?: number | null Optional bounding?: number | null Optional map?: string | null map: string projection: string Email Email
Administration
Settings
: Metadata & { enableComplianceBcc
?: boolean | null ; enableEmailConsentManagement
?: boolean | null ; enableEmailSenderIdCompliance
?: boolean | null ; enableEmailSpfCompliance
?: boolean | null ; enableEmailToSalesforce
?: boolean | null ; enableEmailWorkflowApproval
?: boolean | null ; enableEnhancedEmailEnabled
?: boolean | null ; enableHandleBouncedEmails
?: boolean | null ; enableHtmlEmail
?: boolean | null ; enableListEmailLogActivities
?: boolean | null ; enableResendBouncedEmails
?: boolean | null ; enableRestrictTlsToDomains
?: boolean | null ; enableSendThroughGmailPref
?: boolean | null ; enableSendViaExchangePref
?: boolean | null ; enableSendViaGmailPref
?: boolean | null ; enableSetMatchingEmailsOnBounce
?: boolean | null ; enableUseOrgFootersForExtTrans
?: boolean | null ; sendEmailsEvenWhenAutomationUpdatesSameRecord
?: boolean | null ; sendMassEmailNotification
?: boolean | null ; sendTextOnlySystemEmails
?: boolean | null } Email Email
Integration
Settings
: Metadata & { doesEmailLogAsEmailMessageInOutlook
?: boolean | null ; doesGmailStayConnectedToSalesforce
?: boolean | null ; enableContactAndEventSync
?: boolean | null ; enableEmailTrackingInMobile
?: boolean | null ; enableEngageForOutlook
?: boolean | null ; enableGmailIntegration
?: boolean | null ; enableOutlookIntegration
?: boolean | null ; enableProductivityFeatures
?: boolean | null ; enableSupplementalContactInfoInMobile
?: boolean | null ; isLayoutCustomizationAllowed
?: boolean | null ; shouldUseTrustedDomainsList
?: boolean | null } Email Email: { authorizedSenders?: string | null ; developerName: string ; isActive?: boolean | null ; localPart: string ; runAsUser: string }
Type declaration Optional authorized?: string | null developer: string Optional is?: boolean | null local: string run: string Email Email
Services
Function
: Metadata & { apexClass
: string ; attachmentOption
: string ; authenticationFailureAction
: string ; authorizationFailureAction
: string ; authorizedSenders
?: string | null ; emailServicesAddresses
: EmailServicesAddress [] ; errorRoutingAddress
?: string | null ; functionInactiveAction
: string ; functionName
: string ; isActive
?: boolean | null ; isAuthenticationRequired
?: boolean | null ; isErrorRoutingEnabled
?: boolean | null ; isTextAttachmentsAsBinary
?: boolean | null ; isTlsRequired
?: boolean | null ; overLimitAction
: string } Email Email
Template
: MetadataWithContent & { apiVersion
?: number | null ; attachedDocuments
: string [] ; attachments
: Attachment [] ; available
: boolean ; description
?: string | null ; encodingKey
: string ; letterhead
?: string | null ; name
: string ; packageVersions
: PackageVersion [] ; relatedEntityType
?: string | null ; style
: string ; subject
?: string | null ; textOnly
?: string | null ; type
: string ; uiType
?: string | null } Email Email
Template
Settings
: Metadata & { enableLwcEmailTemplateBuilder
?: boolean | null ; enableTemplateEnhancedFolderPref
?: boolean | null } Email Email: { addressType?: string | null ; authorizedSenders?: string | null ; caseOrigin?: string | null ; caseOwner?: string | null ; caseOwnerType?: string | null ; casePriority?: string | null ; createTask?: boolean | null ; emailAddress?: string | null ; emailServicesAddress?: string | null ; isVerified?: boolean | null ; routingName?: string | null ; saveEmailHeaders?: boolean | null ; taskStatus?: string | null }
Type declaration Optional address?: string | null Optional authorized?: string | null Optional case?: string | null Optional case?: string | null Optional case?: string | null Optional case?: string | null Optional create?: boolean | null Optional email?: string | null Optional email?: string | null Optional is?: boolean | null Optional routing?: string | null Optional save?: boolean | null Optional task?: string | null Email Email
To
Case
Settings
: { enableE2CAttachmentAsFile
?: boolean | null ; enableE2CSourceTracking
?: boolean | null ; enableEmailToCase
?: boolean | null ; enableHtmlEmail
?: boolean | null ; enableOnDemandEmailToCase
?: boolean | null ; enableThreadIDInBody
?: boolean | null ; enableThreadIDInSubject
?: boolean | null ; notifyOwnerOnNewCaseEmail
?: boolean | null ; overEmailLimitAction
?: string | null ; preQuoteSignature
?: boolean | null ; routingAddresses
: EmailToCaseRoutingAddress [] ; unauthorizedSenderAction
?: string | null } Type declaration Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional notify?: boolean | null Optional over?: string | null Optional pre?: boolean | null Optional unauthorized?: string | null Embedded Embedded: { appointmentConfirmImg?: string | null ; enabled: boolean ; homeImg?: string | null ; logoImg?: string | null ; shouldShowExistingAppointment?: boolean | null ; shouldShowNewAppointment?: boolean | null }
Type declaration Optional appointment?: string | null enabled: boolean Optional home?: string | null Optional logo?: string | null Optional should?: boolean | null Optional should?: boolean | null Embedded Embedded
Service
Branding
: Metadata & { contrastInvertedColor
?: string | null ; contrastPrimaryColor
?: string | null ; embeddedServiceConfig
: string ; font
?: string | null ; height
?: number | null ; masterLabel
: string ; navBarColor
?: string | null ; primaryColor
?: string | null ; secondaryColor
?: string | null ; width
?: number | null } Embedded Embedded: { componentBundleType?: string | null ; customComponent?: string | null ; customComponentType?: string | null }
Type declaration Optional component?: string | null Optional custom?: string | null Optional custom?: string | null Embedded Embedded: { customLabel?: string | null ; feature?: string | null ; labelKey?: string | null }
Type declaration Optional custom?: string | null Optional feature?: string | null Optional label?: string | null Embedded Embedded: { flow: string ; flowType: string ; isAuthenticationRequired: boolean }
Type declaration flow: string flow: string is: boolean Embedded Embedded
Service
Flow
Config
: Metadata & { enabled
: boolean } Embedded Embedded
Service
Layout
: { embeddedServiceLayoutRules
: EmbeddedServiceLayoutRule [] ; layout
: string ; layoutType
?: string | null } Type declaration layout: string Optional layout?: string | null Embedded Embedded: { appointmentStatus: string }
Type declaration appointment: string Embedded Embedded
Service
Live
Agent
: Metadata & { avatarImg
?: string | null ; embeddedServiceConfig
: string ; embeddedServiceQuickActions
: EmbeddedServiceQuickAction [] ; enabled
: boolean ; fontSize
: string ; headerBackgroundImg
?: string | null ; isOfflineCaseEnabled
?: boolean | null ; isQueuePositionEnabled
?: boolean | null ; liveAgentChatUrl
?: string | null ; liveAgentContentUrl
?: string | null ; liveChatButton
: string ; liveChatDeployment
: string ; masterLabel
: string ; offlineCaseBackgroundImg
?: string | null ; prechatBackgroundImg
?: string | null ; prechatEnabled
: boolean ; prechatJson
?: string | null ; scenario
: string ; smallCompanyLogoImg
?: string | null ; waitingStateBackgroundImg
?: string | null } Embedded Embedded: { channel?: string | null ; channelType?: string | null ; displayOrder?: number | null ; phoneNumber?: string | null }
Type declaration Optional channel?: string | null Optional channel?: string | null Optional display?: number | null Optional phone?: string | null Embedded Embedded
Service
Menu
Settings
: Metadata & { branding
?: string | null ; embeddedServiceMenuItems
: EmbeddedServiceMenuItem [] ; isEnabled
?: boolean | null ; masterLabel
?: string | null ; site
?: string | null } Embedded Embedded: { embeddedServiceLiveAgent: string ; order: number ; quickActionDefinition: string ; quickActionType?: string | null }
Type declaration embedded: string order: number quick: string Optional quick?: string | null Encryption Encryption
Key
Settings
: Metadata & { canOptOutOfDerivationWithBYOK
?: boolean | null ; enableCacheOnlyKeys
?: boolean | null ; enableReplayDetection
?: boolean | null } Enhanced Enhanced
Notes
Settings
: Metadata & { enableEnhancedNotes
?: boolean | null ; enableTasksOnEnhancedNotes
?: boolean | null } Entitlement Entitlement
Process
: Metadata & { SObjectType
?: string | null ; active
?: boolean | null ; businessHours
?: string | null ; description
?: string | null ; entryStartDateField
?: string | null ; exitCriteriaBooleanFilter
?: string | null ; exitCriteriaFilterItems
: FilterItem [] ; exitCriteriaFormula
?: string | null ; isRecordTypeApplied
?: boolean | null ; isVersionDefault
?: boolean | null ; milestones
: EntitlementProcessMilestoneItem [] ; name
?: string | null ; recordType
?: string | null ; versionMaster
?: string | null ; versionNotes
?: string | null ; versionNumber
?: number | null } Entitlement Entitlement
Process
Milestone
Item
: { businessHours
?: string | null ; criteriaBooleanFilter
?: string | null ; milestoneCriteriaFilterItems
: FilterItem [] ; milestoneCriteriaFormula
?: string | null ; milestoneName
?: string | null ; minutesCustomClass
?: string | null ; minutesToComplete
?: number | null ; successActions
: WorkflowActionReference [] ; timeTriggers
: EntitlementProcessMilestoneTimeTrigger [] ; useCriteriaStartTime
?: boolean | null } Type declaration Optional business?: string | null Optional criteria?: string | null milestone: FilterItem [] Optional milestone?: string | null Optional milestone?: string | null Optional minutes?: string | null Optional minutes?: number | null Optional use?: boolean | null Entitlement Entitlement
Process
Milestone
Time
Trigger
: { actions
: WorkflowActionReference [] ; timeLength
?: number | null ; workflowTimeTriggerUnit
: string } Type declaration Optional time?: number | null workflow: string Entitlement Entitlement
Settings
: Metadata & { assetLookupLimitedToActiveEntitlementsOnAccount
?: boolean | null ; assetLookupLimitedToActiveEntitlementsOnContact
?: boolean | null ; assetLookupLimitedToSameAccount
?: boolean | null ; assetLookupLimitedToSameContact
?: boolean | null ; enableEntitlementVersioning
: boolean ; enableEntitlements
: boolean ; enableMilestoneFeedItem
?: boolean | null ; enableMilestoneStoppedTime
?: boolean | null ; entitlementLookupLimitedToActiveStatus
?: boolean | null ; entitlementLookupLimitedToSameAccount
?: boolean | null ; entitlementLookupLimitedToSameAsset
?: boolean | null ; entitlementLookupLimitedToSameContact
?: boolean | null ; ignoreMilestoneBusinessHours
?: boolean | null } Entitlement Entitlement
Template
: Metadata & { businessHours
?: string | null ; casesPerEntitlement
?: number | null ; entitlementProcess
?: string | null ; isPerIncident
?: boolean | null ; term
?: number | null ; type
?: string | null } Entity Entity
Implements
: Metadata & { fieldMap
: FieldImplements [] ; interface
?: string | null ; isDefault
?: boolean | null } Error Error
: { extendedErrorDetails
: ExtendedErrorDetails [] ; fields
: string [] ; message
: string ; statusCode
: string } Type declaration fields: string [] message: string status: string Escalation Escalation: { assignedTo?: string | null ; assignedToTemplate?: string | null ; assignedToType?: string | null ; minutesToEscalation?: number | null ; notifyCaseOwner?: boolean | null ; notifyEmail: string [] ; notifyTo?: string | null ; notifyToTemplate?: string | null }
Type declaration Optional assigned?: string | null Optional assigned?: string | null Optional assigned?: string | null Optional minutes?: number | null Optional notify?: boolean | null notify: string [] Optional notify?: string | null Optional notify?: string | null Essentials Essentials
Settings
: Metadata & { emailConnectorEnabled
?: boolean | null ; essentialsAppEnabled
?: boolean | null } Essentials Essentials
Trial
Org
Settings
: Metadata & { enableSampleDataDeleted
?: boolean | null } Event Event
Settings
: Metadata & { enableApexLimitEvents
?: boolean | null ; enableDeleteMonitoringData
?: boolean | null ; enableDynamicStreamingChannel
?: boolean | null ; enableEventLogWaveIntegration
?: boolean | null ; enableLoginForensics
?: boolean | null ; enableStreamingApi
?: boolean | null ; enableTerminateOldestSession
?: boolean | null ; enableTransactionSecurityPolicies
?: boolean | null } Experience Experience
Bundle
Settings
: Metadata & { enableExperienceBundleMetadata
?: boolean | null } Extended Extended: { extendedErrorCode: string }
Type declaration extended: string External External: { propertyName: string ; propertyValue: string }
Type declaration property: string property: string External External
Data
Source
: Metadata & { authProvider
?: string | null ; certificate
?: string | null ; customConfiguration
?: string | null ; customHttpHeaders
: CustomHttpHeader [] ; endpoint
?: string | null ; isWritable
?: boolean | null ; label
: string ; oauthRefreshToken
?: string | null ; oauthScope
?: string | null ; oauthToken
?: string | null ; password
?: string | null ; principalType
: string ; protocol
: string ; repository
?: string | null ; type
: string ; username
?: string | null ; version
?: string | null } External External
Service
Registration
: Metadata & { description
?: string | null ; label
: string ; namedCredential
?: string | null ; schema
?: string | null ; schemaType
?: string | null ; schemaUrl
?: string | null ; status
: string } External External
Services
Settings
: Metadata & { enableEnhancedExternalServices
?: boolean | null } Feed Feed: { feedItemType: string ; feedItemVisibility?: string | null ; relatedSObjectType?: string | null }
Type declaration feed: string Optional feed?: string | null Optional relatedSObject?: string | null Feed Feed: { characterLimit?: number | null ; displayFormat?: string | null ; feedItemType: string }
Type declaration Optional character?: number | null Optional display?: string | null feed: string Feed Feed
Layout
: { autocollapsePublisher
?: boolean | null ; compactFeed
?: boolean | null ; feedFilterPosition
?: string | null ; feedFilters
: FeedLayoutFilter [] ; fullWidthFeed
?: boolean | null ; hideSidebar
?: boolean | null ; highlightExternalFeedItems
?: boolean | null ; leftComponents
: FeedLayoutComponent [] ; rightComponents
: FeedLayoutComponent [] ; useInlineFiltersInConsole
?: boolean | null } Type declaration Optional autocollapse?: boolean | null Optional compact?: boolean | null Optional feed?: string | null Optional full?: boolean | null Optional hide?: boolean | null Optional highlight?: boolean | null Optional use?: boolean | null Feed Feed: { componentType: string ; height?: number | null ; page?: string | null }
Type declaration component: string Optional height?: number | null Optional page?: string | null Feed Feed: { feedFilterName?: string | null ; feedFilterType: string ; feedItemType?: string | null }
Type declaration Optional feed?: string | null feed: string Optional feed?: string | null Field Field: { field?: string | null ; interfaceField?: string | null }
Type declaration Optional field?: string | null Optional interface?: string | null Field Field
Mapping
: { SObjectType
: string ; developerName
: string ; fieldMappingRows
: FieldMappingRow [] ; masterLabel
: string } Type declaration SObject: string developer: string master: string Field Field: { dataServiceField: string ; dataServiceObjectName: string ; priority: number }
Type declaration data: string data: string priority: number Field Field
Mapping
Row
: { SObjectType
: string ; fieldMappingFields
: FieldMappingField [] ; fieldName
: string ; mappingOperation
: string } Type declaration SObject: string field: string mapping: string Field Field: { field: string ; formula?: string | null ; literalValue?: string | null }
Type declaration field: string Optional formula?: string | null Optional literal?: string | null Field Field
Service
Settings
: Metadata & { capacityUsageCalcClassId
?: string | null ; doesAllowEditSaForCrew
?: boolean | null ; doesShareSaParentWoWithAr
?: boolean | null ; doesShareSaWithAr
?: boolean | null ; enableWorkOrders
?: boolean | null ; fieldServiceNotificationsOrgPref
?: boolean | null ; fieldServiceOrgPref
?: boolean | null ; isGeoCodeSyncEnabled
?: boolean | null ; isLocationHistoryEnabled
?: boolean | null ; serviceAppointmentsDueDateOffsetOrgValue
?: number | null ; workOrderLineItemSearchFields
: string [] ; workOrderSearchFields
: string [] } Field Field: { field?: string | null ; isFieldManaged?: boolean | null ; isRequired?: boolean | null }
Type declaration Optional field?: string | null Optional is?: boolean | null Optional is?: boolean | null Field Field: { label: string ; name: string }
Type declaration label: string name: string Field Field: { name: string ; value?: any | null }
Type declaration name: string Optional value?: any | null File File: { createdById: string ; createdByName: string ; createdDate: string ; fileName: string ; fullName: string ; id: string ; lastModifiedById: string ; lastModifiedByName: string ; lastModifiedDate: string ; manageableState?: string | null ; namespacePrefix?: string | null ; type: string }
Type declaration created: string created: string created: string file: string full: string id: string last: string last: string last: string Optional manageable?: string | null Optional namespace?: string | null type: string File File: { behavior: string ; fileType: string ; securityRiskFileType: boolean }
Type declaration behavior: string file: string security: boolean File Files Files
Connect
Settings
: Metadata & { enableContentHubAllowed
?: boolean | null ; enableContentHubCvtLinksAllowed
?: boolean | null ; enableContentHubEOSearchLayout
?: boolean | null } Filter Filter: { field: string ; operation: string ; value?: string | null ; valueField?: string | null }
Type declaration field: string operation: string Optional value?: string | null Optional value?: string | null Find Find: { similarOpportunitiesDisplayColumns: string [] ; similarOpportunitiesMatchFields: string [] }
Type declaration similar: string [] similar: string [] Fiscal Fiscal: { fiscalYearNameBasedOn?: string | null ; startMonth?: string | null }
Type declaration Optional fiscal?: string | null Optional start?: string | null Flexi Flexi
Page
Region
: { appendable
?: string | null ; componentInstances
: ComponentInstance [] ; mode
?: string | null ; name
: string ; prependable
?: string | null ; replaceable
?: string | null ; type
: string } Type declaration Optional appendable?: string | null Optional mode?: string | null name: string Optional prependable?: string | null Optional replaceable?: string | null type: string Flexi Flow Flow Flow
Action
Call
Output
Parameter
: FlowBaseElement & { assignToReference
: string ; name
: string } Flow Flow Flow
Apex
Plugin
Call
Output
Parameter
: FlowBaseElement & { assignToReference
: string ; name
: string } Flow Flow: { flow: string }
Flow Type declaration Optional choice?: string | null name: string Flow Type declaration Optional prompt?: string | null Flow Flow: { elementsNotCovered: string [] ; flowId: string ; flowName: string ; flowNamespace?: string | null ; numElements: number ; numElementsNotCovered: number ; processType: string }
Type declaration elements: string [] flow: string flow: string Optional flow?: string | null num: number num: number process: string Flow Flow: { flowId?: string | null ; flowName?: string | null ; flowNamespace?: string | null ; message: string }
Type declaration Optional flow?: string | null Optional flow?: string | null Optional flow?: string | null message: string Flow Flow
Definition
: Metadata & { activeVersionNumber
?: number | null ; description
?: string | null ; masterLabel
?: string | null } Flow Flow
Definition
Translation
: { flows
: FlowTranslation [] ; fullName
: string ; label
?: string | null } Type declaration full: string Optional label?: string | null Flow Flow
Dynamic
Choice
Set
: FlowElement & { dataType
: string ; displayField
: string ; filters
: FlowRecordFilter [] ; limit
?: number | null ; object
: string ; outputAssignments
: FlowOutputFieldAssignment [] ; picklistField
?: string | null ; picklistObject
?: string | null ; sortField
?: string | null ; sortOrder
?: string | null ; valueField
?: string | null } Flow Flow
Element
: FlowBaseElement & { description
?: string | null ; name
?: string | null } Flow Flow: { booleanValue?: boolean | null ; dateTimeValue?: string | null ; dateValue?: string | null ; elementReference?: string | null ; numberValue?: number | null ; stringValue?: string | null }
Type declaration Optional boolean?: boolean | null Optional date?: string | null Optional date?: string | null Optional element?: string | null Optional number?: number | null Optional string?: string | null Flow Flow
Formula
: FlowElement & { dataType
?: string | null ; expression
: string ; scale
?: number | null } Flow Flow: { errorMessage: string ; formulaExpression: string }
Type declaration error: string formula: string Flow Flow: { errorMessage?: string | null }
Type declaration Optional error?: string | null Flow Flow
Loop
: FlowNode & { assignNextValueToReference
: string ; collectionReference
: string ; iterationOrder
?: string | null ; nextValueConnector
?: FlowConnector | null ; noMoreValuesConnector
?: FlowConnector | null } Flow Flow
Node
: FlowElement & { label
?: string | null ; locationX
: number ; locationY
: number } Flow Flow
Output
Field
Assignment
: FlowBaseElement & { assignToReference
: string ; field
: string } Flow Flow
Record
Lookup
: FlowNode & { assignNullValuesIfNoRecordsFound
?: boolean | null ; connector
?: FlowConnector | null ; faultConnector
?: FlowConnector | null ; filters
: FlowRecordFilter [] ; getFirstRecordOnly
?: boolean | null ; object
: string ; outputAssignments
: FlowOutputFieldAssignment [] ; outputReference
?: string | null ; queriedFields
: string [] ; sortField
?: string | null ; sortOrder
?: string | null ; storeOutputAutomatically
?: boolean | null } Flow Flow: { frequency?: string | null ; startDate?: string | null ; startTime?: string | null }
Type declaration Optional frequency?: string | null Optional start?: string | null Optional start?: string | null Flow Flow
Screen
: FlowNode & { allowBack
?: boolean | null ; allowFinish
?: boolean | null ; allowPause
?: boolean | null ; connector
?: FlowConnector | null ; fields
: FlowScreenField [] ; helpText
?: string | null ; pausedText
?: string | null ; rules
: FlowScreenRule [] ; showFooter
?: boolean | null ; showHeader
?: boolean | null } Flow Flow Flow
Screen
Field
Output
Parameter
: FlowBaseElement & { assignToReference
: string ; name
: string } Flow Type declaration Optional field?: string | null Optional help?: string | null name: string Flow Flow
Screen
Translation
: { fields
: FlowScreenFieldTranslation [] ; helpText
?: string | null ; name
: string ; pausedText
?: string | null } Type declaration Optional help?: string | null name: string Optional paused?: string | null Flow Flow
Settings
: Metadata & { enableFlowBREncodedFixEnabled
?: boolean | null ; enableFlowDeployAsActiveEnabled
?: boolean | null ; enableFlowFieldFilterEnabled
?: boolean | null ; enableFlowFormulasFixEnabled
?: boolean | null ; enableFlowInterviewSharingEnabled
?: boolean | null ; enableFlowNullPreviousValueFix
?: boolean | null ; enableFlowPauseEnabled
?: boolean | null ; enableFlowUseApexExceptionEmail
?: boolean | null ; enableInvocableFlowFixEnabled
?: boolean | null ; enableLightningRuntimeEnabled
?: boolean | null ; enableUseFlowBuilder
?: boolean | null ; isAccessToInvokedApexRequired
?: boolean | null ; isEnhancedFlowListViewVisible
?: boolean | null ; isManageFlowRequiredForAutomationCharts
?: boolean | null } Flow Flow
Stage
: FlowElement & { isActive
: boolean ; label
: string ; stageOrder
: number } Flow Flow: { label?: string | null ; name: string }
Type declaration Optional label?: string | null name: string Flow Flow Flow
Subflow
Output
Assignment
: FlowBaseElement & { assignToReference
: string ; name
: string } Flow Flow: { name: string ; text?: string | null }
Type declaration name: string Optional text?: string | null Flow Type declaration full: string Optional label?: string | null Flow Flow
Variable
: FlowElement & { apexClass
?: string | null ; dataType
: string ; isCollection
?: boolean | null ; isInput
?: boolean | null ; isOutput
?: boolean | null ; objectType
?: string | null ; scale
?: number | null ; value
?: FlowElementReferenceOrValue | null } Flow Flow Flow
Wait
Event
Output
Parameter
: FlowBaseElement & { assignToReference
: string ; name
: string } Folder Folder
: Metadata & { accessType
?: string | null ; folderShares
: FolderShare [] ; name
: string ; publicFolderAccess
?: string | null ; sharedTo
?: SharedTo | null } Folder Folder: { accessLevel: string ; sharedTo: string ; sharedToType: string }
Type declaration access: string shared: string shared: string Forecast Forecast: { beginning: number ; displaying: number ; periodType: string }
Type declaration beginning: number displaying: number period: string Forecasting Forecasting
Category
Mapping
: { forecastingItemCategoryApiName
: string ; weightedSourceCategories
: WeightedSourceCategory [] } Type declaration forecasting: string Forecasting Forecasting: { productFamily?: string | null }
Type declaration Optional product?: string | null Forecasting Type declaration active: boolean displayed: string [] forecasted: string [] forecasting: string has: boolean is: boolean is: boolean is: boolean manager: string [] master: string name: string Optional opportunity?: string | null owner: string [] Optional territory2?: string | null Form Form
: Metadata & { description
?: string | null ; formSections
: FormSection [] ; masterLabel
: string } Form Form: { emptySpace?: boolean | null ; expression?: string | null ; formLayoutableItem?: string | null ; helpText?: string | null }
Type declaration Optional empty?: boolean | null Optional expression?: string | null Optional form?: string | null Optional help?: string | null Form Form
Section
: Metadata & { formColumns
: FormColumn [] ; masterLabel
: string ; tabOrderType
: string } Formula Formula
Settings
: Metadata & { enableDSTAwareDatevalue
?: boolean | null } Global Global: { label: string ; name: string }
Type declaration label: string name: string Global Global
Value
Set
: Metadata & { customValue
: CustomValue [] ; description
?: string | null ; masterLabel
: string ; sorted
: boolean } Global Google Google
Apps
Settings
: Metadata & { enableGmailButtons
?: boolean | null ; enableGmailButtonsAndLinks
?: boolean | null ; enableGmailLinks
?: boolean | null ; enableGoogleDocs
?: boolean | null ; enableGoogleDocsTab
?: boolean | null ; enableGoogleTalk
?: boolean | null ; googleAppsDomain
?: string | null ; googleAppsDomainLinked
?: boolean | null ; googleAppsDomainValidated
?: boolean | null } Group Group
: Metadata & { doesIncludeBosses
?: boolean | null ; name
: string } High High
Velocity
Sales
Settings
: Metadata & { enableDispositionCategory
?: boolean | null ; enableEngagementWaveAnalyticsPref
?: boolean | null ; enableHighVelocitySales
?: boolean | null ; enableHighVelocitySalesSetup
?: boolean | null } History History: { archiveAfterMonths: number ; archiveRetentionYears: number ; description?: string | null }
Type declaration archive: number archive: number Optional description?: string | null Holiday Holiday: { activityDate?: string | null ; businessHours: string [] ; description?: string | null ; endTime?: string | null ; isRecurring?: boolean | null ; name?: string | null ; recurrenceDayOfMonth?: number | null ; recurrenceDayOfWeek: string [] ; recurrenceDayOfWeekMask?: number | null ; recurrenceEndDate?: string | null ; recurrenceInstance?: string | null ; recurrenceInterval?: number | null ; recurrenceMonthOfYear?: string | null ; recurrenceStartDate?: string | null ; recurrenceType?: string | null ; startTime?: string | null }
Type declaration Optional activity?: string | null business: string [] Optional description?: string | null Optional end?: string | null Optional is?: boolean | null Optional name?: string | null Optional recurrence?: number | null recurrence: string [] Optional recurrence?: number | null Optional recurrence?: string | null Optional recurrence?: string | null Optional recurrence?: number | null Optional recurrence?: string | null Optional recurrence?: string | null Optional recurrence?: string | null Optional start?: string | null Home Home
Page
Component
: Metadata & { body
?: string | null ; height
?: number | null ; links
: string [] ; page
?: string | null ; pageComponentType
: string ; showLabel
?: boolean | null ; showScrollbars
?: boolean | null ; width
?: string | null } Home Home
Page
Layout
: Metadata & { narrowComponents
: string [] ; wideComponents
: string [] } Idea Idea: { name: string ; value: number }
Type declaration name: string value: number Ideas Ideas
Settings
: Metadata & { enableChatterProfile
?: boolean | null ; enableHtmlIdea
?: boolean | null ; enableIdeaMultipleCategory
?: boolean | null ; enableIdeaThemes
?: boolean | null ; enableIdeas
?: boolean | null ; enableIdeasControllerExtensions
?: boolean | null ; enableIdeasReputation
?: boolean | null ; halfLife
?: number | null ; ideasProfilePage
?: string | null } If If: { childName: string ; expression: string }
Type declaration child: string expression: string Index Index: { name: string ; sortDirection: string }
Type declaration name: string sort: string Industries Industries
Manufacturing
Settings
: Metadata & { enableIndManufacturing
?: boolean | null ; enableIndustriesMfgAccountForecast
?: boolean | null } Industries Industries
Settings
: Metadata & { allowMultipleProducersToWorkOnSamePolicy
?: boolean | null ; enableAccessToMasterListOfCoverageTypes
?: boolean | null ; enableBlockResourceAvailabilityOrgPref
?: boolean | null ; enableEventManagementOrgPref
?: boolean | null ; enableHCReferralScoring
?: boolean | null ; enableManyToManyRelationships
?: boolean | null ; enableMortgageRlaTotalsOrgPref
?: boolean | null ; enableMultiResourceOrgPref
?: boolean | null ; enableObjectDetection
?: boolean | null ; enableOverbookingOrgPref
?: boolean | null ; enableProviderSearchSyncOrgPref
?: boolean | null ; enableReferralScoring
?: boolean | null ; enableSentimentAnalysis
?: boolean | null } Installed Installed
Package
: Metadata & { activateRSS
: boolean ; password
?: string | null ; versionNumber
: string } Integration Integration
Hub
Settings
: Metadata & { canonicalName
?: string | null ; canonicalNameBindingChar
?: string | null ; description
?: string | null ; isEnabled
?: boolean | null ; isProtected
?: boolean | null ; masterLabel
: string ; setupData
?: string | null ; setupDefinition
?: string | null ; setupNamespace
?: string | null ; setupSimpleName
: string ; uUID
?: string | null ; version
?: string | null ; versionBuild
?: number | null ; versionMajor
?: number | null ; versionMinor
?: number | null ; versionSetUuid
?: string | null } Integration Integration
Hub
Settings
Type
: Metadata & { canonicalName
?: string | null ; canonicalNameBindingChar
?: string | null ; description
?: string | null ; isEnabled
?: boolean | null ; isProtected
?: boolean | null ; masterLabel
: string ; setupNamespace
?: string | null ; setupSimpleName
: string ; uUID
?: string | null ; version
?: string | null ; versionBuild
?: number | null ; versionMajor
?: number | null ; versionMinor
?: number | null ; versionSetUuid
?: string | null } Invocable Invocable
Action
Settings
: Metadata & { isPartialSaveAllowed
?: boolean | null } IoTSettings IoTSettings
: Metadata & { enableIoT
?: boolean | null ; enableIoTInsightsPilot
?: boolean | null ; enableIoTUsageEmail
?: boolean | null } Ip Ip: { description?: string | null ; end?: string | null ; start?: string | null }
Type declaration Optional description?: string | null Optional end?: string | null Optional start?: string | null Isv Isv
Hammer
Settings
: Metadata & { enableIsvHammerSubIsOptedOut
?: boolean | null } Keyword Keyword: { keyword: string }
Keyword Keyword
List
: Metadata & { description
?: string | null ; keywords
: Keyword [] ; masterLabel
: string } Knowledge Knowledge: { assignTo?: string | null ; defaultArticleType?: string | null ; enableArticleCreation?: boolean | null }
Type declaration Optional assign?: string | null Optional default?: string | null Optional enable?: boolean | null Knowledge Knowledge: { name?: string | null }
Type declaration Optional name?: string | null Knowledge Knowledge Knowledge
Case
Settings
: { articlePDFCreationProfile
?: string | null ; articlePublicSharingCommunities
?: KnowledgeCommunitiesSettings | null ; articlePublicSharingSites
?: KnowledgeSitesSettings | null ; articlePublicSharingSitesChatterAnswers
?: KnowledgeSitesSettings | null ; assignTo
?: string | null ; customizationClass
?: string | null ; defaultContributionArticleType
?: string | null ; editor
?: string | null ; enableArticleCreation
?: boolean | null ; enableArticlePublicSharingSites
?: boolean | null ; enableCaseDataCategoryMapping
?: boolean | null ; useProfileForPDFCreation
?: boolean | null } Type declaration Optional articlePDFCreation?: string | null Optional article?: KnowledgeSitesSettings | null Optional assign?: string | null Optional customization?: string | null Optional default?: string | null Optional editor?: string | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional use?: boolean | null Knowledge Knowledge: { community: string [] }
Knowledge Knowledge: { active?: boolean | null ; defaultAssignee?: string | null ; defaultAssigneeType?: string | null ; defaultReviewer?: string | null ; defaultReviewerType?: string | null ; name: string }
Type declaration Optional active?: boolean | null Optional default?: string | null Optional default?: string | null Optional default?: string | null Optional default?: string | null name: string Knowledge Knowledge Knowledge
Settings
: Metadata & { answers
?: KnowledgeAnswerSettings | null ; cases
?: KnowledgeCaseSettings | null ; defaultLanguage
?: string | null ; enableChatterQuestionKBDeflection
?: boolean | null ; enableCreateEditOnArticlesTab
?: boolean | null ; enableExternalMediaContent
?: boolean | null ; enableKnowledge
?: boolean | null ; enableKnowledgeArticleTextHighlights
?: boolean | null ; enableKnowledgeKeywordAutoComplete
?: boolean | null ; enableKnowledgeTitleAutoComplete
?: boolean | null ; enableLightningKbAutoLoadRichTextField
?: boolean | null ; enableLightningKnowledge
?: boolean | null ; languages
?: KnowledgeLanguageSettings | null ; showArticleSummariesCustomerPortal
?: boolean | null ; showArticleSummariesInternalApp
?: boolean | null ; showArticleSummariesPartnerPortal
?: boolean | null ; showValidationStatusField
?: boolean | null ; suggestedArticles
?: KnowledgeSuggestedArticlesSettings | null } Knowledge Knowledge: { site: string [] }
Knowledge Type declaration Optional use?: boolean | null Knowledge Knowledge: { name?: string | null }
Type declaration Optional name?: string | null Knowledge Knowledge Knowledge: { name?: string | null }
Type declaration Optional name?: string | null Knowledge Language Language
Settings
: Metadata & { enableCanadaIcuFormat
?: boolean | null ; enableEndUserLanguages
?: boolean | null ; enableICULocaleDateFormat
?: boolean | null ; enablePlatformLanguages
?: boolean | null ; enableTranslationWorkbench
?: boolean | null ; useLanguageFallback
?: boolean | null } Layout Layout
: Metadata & { customButtons
: string [] ; customConsoleComponents
?: CustomConsoleComponents | null ; emailDefault
?: boolean | null ; excludeButtons
: string [] ; feedLayout
?: FeedLayout | null ; headers
: string [] ; layoutSections
: LayoutSection [] ; miniLayout
?: MiniLayout | null ; multilineLayoutFields
: string [] ; platformActionList
?: PlatformActionList | null ; quickActionList
?: QuickActionList | null ; relatedContent
?: RelatedContent | null ; relatedLists
: RelatedListItem [] ; relatedObjects
: string [] ; runAssignmentRulesDefault
?: boolean | null ; showEmailCheckbox
?: boolean | null ; showHighlightsPanel
?: boolean | null ; showInteractionLogPanel
?: boolean | null ; showKnowledgeComponent
?: boolean | null ; showRunAssignmentRulesCheckbox
?: boolean | null ; showSolutionSection
?: boolean | null ; showSubmitAndAttachButton
?: boolean | null ; summaryLayout
?: SummaryLayout | null } Layout Layout
Column
: { layoutItems
: LayoutItem [] ; reserved
?: string | null } Type declaration Optional reserved?: string | null Layout Layout
Item
: { analyticsCloudComponent
?: AnalyticsCloudComponentLayoutItem | null ; behavior
?: string | null ; canvas
?: string | null ; component
?: string | null ; customLink
?: string | null ; emptySpace
?: boolean | null ; field
?: string | null ; height
?: number | null ; page
?: string | null ; reportChartComponent
?: ReportChartComponentLayoutItem | null ; scontrol
?: string | null ; showLabel
?: boolean | null ; showScrollbars
?: boolean | null ; width
?: string | null } Type declaration Optional behavior?: string | null Optional canvas?: string | null Optional component?: string | null Optional custom?: string | null Optional empty?: boolean | null Optional field?: string | null Optional height?: number | null Optional page?: string | null Optional scontrol?: string | null Optional show?: boolean | null Optional show?: boolean | null Optional width?: string | null Layout Layout
Section
: { customLabel
?: boolean | null ; detailHeading
?: boolean | null ; editHeading
?: boolean | null ; label
?: string | null ; layoutColumns
: LayoutColumn [] ; style
: string } Type declaration Optional custom?: boolean | null Optional detail?: boolean | null Optional edit?: boolean | null Optional label?: string | null style: string Layout Layout: { label: string ; section: string }
Type declaration label: string section: string Layout Type declaration layout: string Optional layout?: string | null Lead Lead
Config
Settings
: Metadata & { doesEnableLeadConvertDefaultSubjectBlankTaskCreation
?: boolean | null ; doesHideOpportunityInConvertLeadWindow
?: boolean | null ; doesPreserveLeadStatus
?: boolean | null ; doesSelectNoOpportunityOnConvertLead
?: boolean | null ; doesTrackHistory
?: boolean | null ; enableConversionsOnMobile
?: boolean | null ; enableOrgWideMergeAndDelete
?: boolean | null ; shouldLeadConvertRequireValidation
?: boolean | null } Lead Lead
Convert
Settings
: Metadata & { allowOwnerChange
?: boolean | null ; objectMapping
: ObjectMapping [] ; opportunityCreationOptions
?: string | null } Letterhead Letterhead: { backgroundColor: string ; height: number ; horizontalAlignment?: string | null ; logo?: string | null ; verticalAlignment?: string | null }
Type declaration background: string height: number Optional horizontal?: string | null Optional logo?: string | null Optional vertical?: string | null Letterhead Letterhead: { color: string ; height: number }
Type declaration color: string height: number License License
Definition
: Metadata & { aggregationGroup
: string ; description
?: string | null ; isPublished
: boolean ; label
: string ; licensedCustomPermissions
: LicensedCustomPermissions [] ; licensingAuthority
: string ; licensingAuthorityProvider
: string ; minPlatformVersion
: number ; origin
: string ; revision
: number ; trialLicenseDuration
: number ; trialLicenseQuantity
: number } Licensed Licensed: { customPermission: string ; licenseDefinition: string }
Type declaration custom: string license: string Lightning Lightning: { description?: string | null ; order: number ; title: string }
Type declaration Optional description?: string | null order: number title: string Lightning Lightning: { image: string ; order: number }
Type declaration image: string order: number Lightning Lightning: { name: string ; type: string }
Lightning Lightning
Component
Bundle
: Metadata & { apiVersion
?: number | null ; description
?: string | null ; isExplicitImport
?: boolean | null ; isExposed
?: boolean | null ; lwcResources
?: LwcResources | null ; masterLabel
?: string | null ; runtimeNamespace
?: string | null ; targetConfigs
?: string | null ; targets
?: Targets | null } Lightning Lightning
Experience
Settings
: Metadata & { enableAccessCheckCrucPref
?: boolean | null ; enableApiUserLtngOutAccessPref
?: boolean | null ; enableAuraCDNPref
?: boolean | null ; enableFeedbackInMobile
?: boolean | null ; enableIE11DeprecationMsgHidden
?: boolean | null ; enableIE11LEXCrucPref
?: boolean | null ; enableInAppTooltips
?: boolean | null ; enableLEXOnIpadEnabled
?: boolean | null ; enableLexEndUsersNoSwitching
?: boolean | null ; enableNavPersonalizationOptOut
?: boolean | null ; enableRemoveThemeBrandBanner
?: boolean | null ; enableS1BannerPref
?: boolean | null ; enableS1BrowserEnabled
?: boolean | null ; enableS1DesktopEnabled
?: boolean | null ; enableS1UiLoggingEnabled
?: boolean | null ; enableTryLightningOptOut
?: boolean | null ; enableUseS1AlohaDesktop
?: boolean | null ; enableUsersAreLightningOnly
?: boolean | null } Lightning Lightning
Experience
Theme
: Metadata & { defaultBrandingSet
: string ; description
?: string | null ; masterLabel
: string ; shouldOverrideLoadingImage
?: boolean | null } Lightning Lightning
Message
Channel
: Metadata & { description
?: string | null ; isExposed
?: boolean | null ; lightningMessageFields
: LightningMessageField [] ; masterLabel
: string } Lightning Lightning: { description?: string | null ; fieldName: string }
Type declaration Optional description?: string | null field: string Lightning Lightning
Onboarding
Config
: Metadata & { collaborationGroup
?: string | null ; customQuestion
: string ; feedbackFormDaysFrequency
: number ; isCustom
: boolean ; masterLabel
: string ; sendFeedbackToSalesforce
: boolean } List List: { folder?: string | null ; type: string }
Type declaration Optional folder?: string | null type: string List List: { height?: number | null ; location: string ; units?: string | null ; width?: number | null }
Type declaration Optional height?: number | null location: string Optional units?: string | null Optional width?: number | null List List
View
: Metadata & { booleanFilter
?: string | null ; columns
: string [] ; division
?: string | null ; filterScope
: string ; filters
: ListViewFilter [] ; label
: string ; language
?: string | null ; queue
?: string | null ; sharedTo
?: SharedTo | null } List List: { field: string ; operation: string ; value?: string | null }
Type declaration field: string operation: string Optional value?: string | null Live Live: { enableLiveChat?: boolean | null ; openNewAccountSubtab?: boolean | null ; openNewCaseSubtab?: boolean | null ; openNewContactSubtab?: boolean | null ; openNewLeadSubtab?: boolean | null ; openNewVFPageSubtab?: boolean | null ; pageNamesToOpen: string [] ; showKnowledgeArticles?: boolean | null }
Type declaration Optional enable?: boolean | null Optional open?: boolean | null Optional open?: boolean | null Optional open?: boolean | null Optional open?: boolean | null Optional open?: boolean | null page: string [] Optional show?: boolean | null Live Live
Agent
Settings
: Metadata & { enableLiveAgent
?: boolean | null ; enableQuickTextEnabled
?: boolean | null } Live Live
Chat
Agent
Config
: Metadata & { assignments
?: AgentConfigAssignments | null ; autoGreeting
?: string | null ; capacity
?: number | null ; criticalWaitTime
?: number | null ; customAgentName
?: string | null ; enableAgentFileTransfer
?: boolean | null ; enableAgentSneakPeek
?: boolean | null ; enableAssistanceFlag
?: boolean | null ; enableAutoAwayOnDecline
?: boolean | null ; enableAutoAwayOnPushTimeout
?: boolean | null ; enableChatConferencing
?: boolean | null ; enableChatMonitoring
?: boolean | null ; enableChatTransferToAgent
?: boolean | null ; enableChatTransferToButton
?: boolean | null ; enableChatTransferToSkill
?: boolean | null ; enableLogoutSound
?: boolean | null ; enableNotifications
?: boolean | null ; enableRequestSound
?: boolean | null ; enableSneakPeek
?: boolean | null ; enableVisitorBlocking
?: boolean | null ; enableWhisperMessage
?: boolean | null ; label
: string ; supervisorDefaultAgentStatusFilter
?: string | null ; supervisorDefaultButtonFilter
?: string | null ; supervisorDefaultSkillFilter
?: string | null ; supervisorSkills
?: SupervisorAgentConfigSkills | null ; transferableButtons
?: AgentConfigButtons | null ; transferableSkills
?: AgentConfigSkills | null } Live Live
Chat
Button
: Metadata & { animation
?: string | null ; autoGreeting
?: string | null ; chasitorIdleTimeout
?: number | null ; chasitorIdleTimeoutWarning
?: number | null ; chatPage
?: string | null ; customAgentName
?: string | null ; deployments
?: LiveChatButtonDeployments | null ; enableQueue
?: boolean | null ; inviteEndPosition
?: string | null ; inviteImage
?: string | null ; inviteStartPosition
?: string | null ; isActive
?: boolean | null ; label
: string ; numberOfReroutingAttempts
?: number | null ; offlineImage
?: string | null ; onlineImage
?: string | null ; optionsCustomRoutingIsEnabled
?: boolean | null ; optionsHasChasitorIdleTimeout
: boolean ; optionsHasInviteAfterAccept
?: boolean | null ; optionsHasInviteAfterReject
?: boolean | null ; optionsHasRerouteDeclinedRequest
?: boolean | null ; optionsIsAutoAccept
?: boolean | null ; optionsIsInviteAutoRemove
?: boolean | null ; overallQueueLength
?: number | null ; perAgentQueueLength
?: number | null ; postChatPage
?: string | null ; postChatUrl
?: string | null ; preChatFormPage
?: string | null ; preChatFormUrl
?: string | null ; pushTimeOut
?: number | null ; routingType
: string ; site
?: string | null ; skills
?: LiveChatButtonSkills | null ; timeToRemoveInvite
?: number | null ; type
: string ; windowLanguage
?: string | null } Live Live: { deployment: string [] }
Live Live: { skill: string [] }
Live Live
Chat
Deployment
: Metadata & { brandingImage
?: string | null ; connectionTimeoutDuration
?: number | null ; connectionWarningDuration
?: number | null ; displayQueuePosition
?: boolean | null ; domainWhiteList
?: LiveChatDeploymentDomainWhitelist | null ; enablePrechatApi
?: boolean | null ; enableTranscriptSave
?: boolean | null ; label
: string ; mobileBrandingImage
?: string | null ; site
?: string | null ; windowTitle
: string } Live Live: { domain: string [] }
Live Live
Chat
Sensitive
Data
Rule
: Metadata & { actionType
: string ; description
?: string | null ; enforceOn
: number ; isEnabled
: boolean ; pattern
: string ; priority
: number ; replacement
?: string | null } Live Live
Message
Settings
: Metadata & { enableLiveMessage
?: boolean | null } Local Local
Ml
Domain
: { label
: string ; mlIntents
: MlIntent [] ; mlSlotClasses
: MlSlotClass [] ; name
: string } Type declaration label: string name: string Log Log: { category: string ; level: string }
Type declaration category: string level: string Lookup Lookup
Filter
: { active
: boolean ; booleanFilter
?: string | null ; description
?: string | null ; errorMessage
?: string | null ; filterItems
: FilterItem [] ; infoMessage
?: string | null ; isOptional
: boolean } Type declaration active: boolean Optional boolean?: string | null Optional description?: string | null Optional error?: string | null Optional info?: string | null is: boolean Lookup Lookup: { errorMessage: string ; informationalMessage: string }
Type declaration error: string informational: string Lwc Lwc: { filePath: string ; source: string }
Type declaration file: string source: string Macro Macro
Settings
: Metadata & { enableAdvancedSearch
?: boolean | null ; macrosInFolders
?: boolean | null } Managed Managed: { helpText?: string | null ; isLocalizable?: boolean | null ; isRequired?: boolean | null ; nodeLabel: string ; nodeName: string ; nodeType: string ; placeholderText?: string | null }
Type declaration Optional help?: string | null Optional is?: boolean | null Optional is?: boolean | null node: string node: string node: string Optional placeholder?: string | null Managed Managed
Content
Type
: Metadata & { description
?: string | null ; developerName
: string ; managedContentNodeTypes
: ManagedContentNodeType [] ; masterLabel
: string } Managed Managed
Topic
: Metadata & { managedTopicType
: string ; name
: string ; parentName
: string ; position
: number ; topicDescription
: string } Map Map: { expression: string ; name: string ; type: string }
Type declaration expression: string name: string type: string Maps Maps
And
Location
Settings
: Metadata & { enableAddressAutoComplete
?: boolean | null ; enableMapsAndLocation
?: boolean | null } Matching Matching
Rule
: Metadata & { booleanFilter
?: string | null ; description
?: string | null ; label
: string ; matchingRuleItems
: MatchingRuleItem [] ; ruleStatus
: string } Matching Matching: { blankValueBehavior?: string | null ; fieldName: string ; matchingMethod: string }
Type declaration Optional blank?: string | null field: string matching: string Metadata Metadata: { fullName?: string | null }
Type declaration Optional full?: string | null Metadata Metadata
With
Content
: Metadata & { content
?: string | null } Milestone Milestone
Type
: Metadata & { description
?: string | null ; recurrenceType
?: string | null } Ml Type declaration Optional description?: string | null developer: string label: string Ml Ml: { utterance: string }
Ml Ml: { relatedMlIntent: string }
Ml Ml
Slot
Class
: { dataType
: string ; description
?: string | null ; developerName
: string ; extractionRegex
?: string | null ; extractionType
?: string | null ; label
: string ; mlSlotClassValues
: MlSlotClassValue [] } Type declaration data: string Optional description?: string | null developer: string Optional extraction?: string | null Optional extraction?: string | null label: string Ml Ml
Slot
Class
Value
: { synonymGroup
?: SynonymGroup | null ; value
: string } Mobile Mobile
Application
Detail
: Metadata & { applicationBinaryFile
?: string | null ; applicationBinaryFileName
?: string | null ; applicationBundleIdentifier
?: string | null ; applicationFileLength
?: number | null ; applicationIconFile
?: string | null ; applicationIconFileName
?: string | null ; applicationInstallUrl
?: string | null ; devicePlatform
: string ; deviceType
?: string | null ; minimumOsVersion
?: string | null ; privateApp
?: boolean | null ; version
: string } Mobile Mobile
Settings
: Metadata & { dashboardMobile
?: DashboardMobileSettings | null ; enableImportContactFromDevice
?: boolean | null ; enableLightningOnMobile
?: boolean | null ; enableOfflineDraftsEnabled
?: boolean | null ; enablePopulateNameManuallyInToday
?: boolean | null ; enableS1EncryptedStoragePref2
?: boolean | null ; enableS1OfflinePref
?: boolean | null } Moderated Moderated: { entityName: string ; fieldName?: string | null ; keywordList?: string | null }
Type declaration entity: string Optional field?: string | null Optional keyword?: string | null Moderation Moderation
Rule
: Metadata & { action
: string ; actionLimit
?: number | null ; active
: boolean ; description
?: string | null ; entitiesAndFields
: ModeratedEntityField [] ; masterLabel
: string ; notifyLimit
?: number | null ; timePeriod
?: string | null ; type
?: string | null ; userCriteria
: string [] ; userMessage
?: string | null } My My
Domain
Settings
: Metadata & { canOnlyLoginWithMyDomainUrl
?: boolean | null ; doesApiLoginRequireOrgDomain
?: boolean | null ; enableNativeBrowserForAuthOnAndroid
?: boolean | null ; enableNativeBrowserForAuthOnIos
?: boolean | null ; useStabilizedMyDomainHostnames
?: boolean | null ; useStabilizedSandboxMyDomainHostnames
?: boolean | null } Name Name
Settings
: Metadata & { enableMiddleName
?: boolean | null ; enableNameSuffix
?: boolean | null } Named Named
Credential
: Metadata & { allowMergeFieldsInBody
?: boolean | null ; allowMergeFieldsInHeader
?: boolean | null ; authProvider
?: string | null ; authTokenEndpointUrl
?: string | null ; awsAccessKey
?: string | null ; awsAccessSecret
?: string | null ; awsRegion
?: string | null ; awsService
?: string | null ; certificate
?: string | null ; endpoint
?: string | null ; generateAuthorizationHeader
?: boolean | null ; jwtAudience
?: string | null ; jwtFormulaSubject
?: string | null ; jwtIssuer
?: string | null ; jwtSigningCertificate
?: string | null ; jwtTextSubject
?: string | null ; jwtValidityPeriodSeconds
?: number | null ; label
: string ; oauthRefreshToken
?: string | null ; oauthScope
?: string | null ; oauthToken
?: string | null ; password
?: string | null ; principalType
: string ; privateConnection
?: string | null ; protocol
: string ; username
?: string | null } Navigation Navigation
Menu
Item
: { defaultListViewId
?: string | null ; label
: string ; menuItemBranding
?: NavigationMenuItemBranding | null ; position
: number ; publiclyAvailable
?: boolean | null ; subMenu
?: NavigationSubMenu | null ; target
?: string | null ; targetPreference
?: string | null ; type
: string } Type declaration Optional default?: string | null label: string position: number Optional publicly?: boolean | null Optional target?: string | null Optional target?: string | null type: string Navigation Navigation: { tileImage?: string | null }
Type declaration Optional tile?: string | null Network Network
: Metadata & { allowInternalUserLogin
?: boolean | null ; allowMembersToFlag
?: boolean | null ; allowedExtensions
?: string | null ; caseCommentEmailTemplate
?: string | null ; changePasswordTemplate
: string ; communityRoles
?: CommunityRoles | null ; description
?: string | null ; disableReputationRecordConversations
?: boolean | null ; emailFooterLogo
?: string | null ; emailFooterText
?: string | null ; emailSenderAddress
: string ; emailSenderName
: string ; enableCustomVFErrorPageOverrides
?: boolean | null ; enableDirectMessages
?: boolean | null ; enableGuestChatter
?: boolean | null ; enableGuestFileAccess
?: boolean | null ; enableGuestMemberVisibility
?: boolean | null ; enableInvitation
?: boolean | null ; enableKnowledgeable
?: boolean | null ; enableMemberVisibility
?: boolean | null ; enableNicknameDisplay
?: boolean | null ; enablePrivateMessages
?: boolean | null ; enableReputation
?: boolean | null ; enableShowAllNetworkSettings
?: boolean | null ; enableSiteAsContainer
?: boolean | null ; enableTalkingAboutStats
?: boolean | null ; enableTopicAssignmentRules
?: boolean | null ; enableTopicSuggestions
?: boolean | null ; enableUpDownVote
?: boolean | null ; feedChannel
?: string | null ; forgotPasswordTemplate
: string ; gatherCustomerSentimentData
?: boolean | null ; lockoutTemplate
?: string | null ; logoutUrl
?: string | null ; maxFileSizeKb
?: number | null ; navigationLinkSet
?: NavigationLinkSet | null ; networkMemberGroups
?: NetworkMemberGroup | null ; networkPageOverrides
?: NetworkPageOverride | null ; newSenderAddress
?: string | null ; picassoSite
?: string | null ; recommendationAudience
?: RecommendationAudience | null ; recommendationDefinition
?: RecommendationDefinition | null ; reputationLevels
?: ReputationLevelDefinitions | null ; reputationPointsRules
?: ReputationPointsRules | null ; selfRegProfile
?: string | null ; selfRegistration
?: boolean | null ; sendWelcomeEmail
?: boolean | null ; site
: string ; status
: string ; tabs
: NetworkTabSet ; urlPathPrefix
?: string | null ; verificationTemplate
?: string | null ; welcomeTemplate
: string } Network Network
Access
: { ipRanges
: IpRange [] } Network Network
Branding
: MetadataWithContent & { loginBackgroundImageUrl
?: string | null ; loginFooterText
?: string | null ; loginLogo
?: string | null ; loginLogoName
?: string | null ; loginPrimaryColor
?: string | null ; loginQuaternaryColor
?: string | null ; loginRightFrameUrl
?: string | null ; network
?: string | null ; pageFooter
?: string | null ; pageHeader
?: string | null ; primaryColor
: string ; primaryComplementColor
: string ; quaternaryColor
: string ; quaternaryComplementColor
: string ; secondaryColor
: string ; staticLogoImageUrl
?: string | null ; tertiaryColor
: string ; tertiaryComplementColor
: string ; zeronaryColor
: string ; zeronaryComplementColor
: string } Network Network: { permissionSet: string [] ; profile: string [] }
Type declaration permission: string [] profile: string [] Network Network: { changePasswordPageOverrideSetting?: string | null ; forgotPasswordPageOverrideSetting?: string | null ; homePageOverrideSetting?: string | null ; loginPageOverrideSetting?: string | null ; selfRegProfilePageOverrideSetting?: string | null }
Type declaration Optional change?: string | null Optional forgot?: string | null Optional home?: string | null Optional login?: string | null Optional self?: string | null Network Network: { customTab: string [] ; defaultTab: string ; standardTab: string [] }
Type declaration custom: string [] default: string standard: string [] Next Next: { useApproverFieldOfRecordOwner?: boolean | null ; userHierarchyField: string }
Type declaration Optional use?: boolean | null user: string Notifications Notifications
Settings
: Metadata & { enableMobileAppPushNotifications
?: boolean | null ; enableNotifications
?: boolean | null } Oauth Oauth
Custom
Scope
: Metadata & { description
: string ; developerName
: string ; isProtected
?: boolean | null ; isPublic
?: boolean | null ; masterLabel
: string } Object Object
Linking
Settings
: Metadata & { enableObjectLinking
?: boolean | null } Object Object
Mapping
: { inputObject
: string ; mappingFields
: ObjectMappingField [] ; outputObject
: string } Type declaration input: string output: string Object Object: { inputField: string ; outputField: string }
Type declaration input: string output: string Object Object: { article?: string | null ; caseType?: string | null ; plural?: boolean | null ; possessive?: string | null ; value: string }
Type declaration Optional article?: string | null Optional case?: string | null Optional plural?: boolean | null Optional possessive?: string | null value: string Object Object
Relationship
: { join
?: ObjectRelationship | null ; outerJoin
: boolean ; relationship
: string } Type declaration outer: boolean relationship: string Object Object: { enhancedLookupEnabled: boolean ; lookupAutoCompleteEnabled: boolean ; name: string ; resultsPerPageCount: number }
Type declaration enhanced: boolean lookup: boolean name: string results: number Object Object: { object: string [] }
Omni Omni
Channel
Settings
: Metadata & { enableOmniAutoLoginPrompt
?: boolean | null ; enableOmniChannel
?: boolean | null ; enableOmniSecondaryRoutingPriority
?: boolean | null ; enableOmniSkillsRouting
?: boolean | null } Opportunity Opportunity: { field: string ; label: string }
Type declaration field: string label: string Opportunity Opportunity: { field: string [] }
Opportunity Opportunity: { field: string [] }
Opportunity Opportunity
Settings
: Metadata & { autoActivateNewReminders
?: boolean | null ; customizableProductSchedulesEnabled
?: boolean | null ; doesAutoAddSplitOwnerAsOpportunityTeamMember
?: boolean | null ; doesEnforceStandardOpportunitySaveLogic
?: boolean | null ; enableFindSimilarOpportunities
?: boolean | null ; enableOpportunityFieldHistoryTracking
?: boolean | null ; enableOpportunityInsightsInMobile
?: boolean | null ; enableOpportunityTeam
?: boolean | null ; enableUpdateReminders
?: boolean | null ; findSimilarOppFilter
?: FindSimilarOppFilter | null ; promptToAddProducts
?: boolean | null } Orchestration Orchestration
Context
: Metadata & { datasets
: OrchestrationContextDataset [] ; description
?: string | null ; events
: OrchestrationContextEvent [] ; imageFile
: string ; imageScale
: number ; masterLabel
: string ; runtimeType
: string ; salesforceObject
?: string | null ; salesforceObjectPrimaryKey
?: string | null } Orchestration Orchestration: { datasetType: string ; orchestrationDataset: string }
Type declaration dataset: string orchestration: string Orchestration Orchestration: { eventType: string ; orchestrationEvent: string ; platformEvent: string ; platformEventPrimaryKey: string }
Type declaration event: string orchestration: string platform: string platform: string Order Order
Management
Settings
: Metadata & { enableOrderManagement
?: boolean | null } Order Order
Settings
: Metadata & { enableNegativeQuantity
?: boolean | null ; enableOrders
?: boolean | null ; enableReductionOrders
?: boolean | null ; enableZeroQuantity
?: boolean | null } Org Org
Settings
: Metadata & { enableCustomerSuccessPortal
?: boolean | null ; enableExtendedMailMerge
?: boolean | null ; enableIncludeContractStatus
?: boolean | null ; enableMakeDeploymentsMandatory
?: boolean | null ; enableManageSelfServiceUsers
?: boolean | null ; enableOrgFeedSentimentAnalysis
?: boolean | null ; enableRADeploymentAttributeOnly
?: boolean | null ; enableResetDivisionOnLogin
?: boolean | null ; saveMailMergeDocsAsSalesforceDocs
?: boolean | null } Organization Organization: { settingName: string ; settingValue: boolean }
Type declaration setting: string setting: boolean Package Package
: Metadata & { apiAccessLevel
?: string | null ; description
?: string | null ; namespacePrefix
?: string | null ; objectPermissions
: ProfileObjectPermissions [] ; packageType
?: string | null ; postInstallClass
?: string | null ; setupWeblink
?: string | null ; types
: PackageTypeMembers [] ; uninstallClass
?: string | null ; version
: string } Package Package: { members: string [] ; name: string }
Type declaration members: string [] name: string Package Package: { majorNumber: number ; minorNumber: number ; namespace: string }
Type declaration major: number minor: number namespace: string Pardot Pardot
Einstein
Settings
: Metadata & { enableCampaignInsight
?: boolean | null ; enableEngagementScore
?: boolean | null } Pardot Pardot
Settings
: Metadata & { enableB2bmaAppEnabled
?: boolean | null ; enableEngagementHistoryDashboards
?: boolean | null ; enablePardotAppV1Enabled
?: boolean | null ; enablePardotEnabled
?: boolean | null ; enableProspectActivityDataset
?: boolean | null } Party Party
Data
Model
Settings
: Metadata & { enableAutoSelectIndividualOnMerge
?: boolean | null ; enableConsentManagement
?: boolean | null } Password Password: { apiOnlyUserHomePageURL?: string | null ; complexity?: string | null ; enableSetPasswordInApi?: boolean | null ; expiration?: string | null ; historyRestriction?: string | null ; lockoutInterval?: string | null ; maxLoginAttempts?: string | null ; minimumPasswordLength?: string | null ; minimumPasswordLifetime?: boolean | null ; obscureSecretAnswer?: boolean | null ; passwordAssistanceMessage?: string | null ; passwordAssistanceURL?: string | null ; questionRestriction?: string | null }
Type declaration Optional api?: string | null Optional complexity?: string | null Optional enable?: boolean | null Optional expiration?: string | null Optional history?: string | null Optional lockout?: string | null Optional max?: string | null Optional minimum?: string | null Optional minimum?: boolean | null Optional obscure?: boolean | null Optional password?: string | null Optional password?: string | null Optional question?: string | null Path Path
Assistant
: Metadata & { active
: boolean ; entityName
: string ; fieldName
: string ; masterLabel
: string ; pathAssistantSteps
: PathAssistantStep [] ; recordTypeName
: string } Path Path
Assistant
Settings
: Metadata & { canOverrideAutoPathCollapseWithUserPref
?: boolean | null ; pathAssistantEnabled
?: boolean | null } Path Path: { fieldNames: string [] ; info?: string | null ; picklistValueName: string }
Type declaration field: string [] Optional info?: string | null picklist: string Permission Permission: { apexClass: string ; enabled: boolean }
Type declaration apex: string enabled: boolean Permission Permission: { apexPage: string ; enabled: boolean }
Type declaration apex: string enabled: boolean Permission Permission: { application: string ; visible: boolean }
Type declaration application: string visible: boolean Permission Permission: { enabled: boolean ; name: string }
Type declaration enabled: boolean name: string Permission Permission: { enabled: boolean ; name: string }
Type declaration enabled: boolean name: string Permission Permission: { enabled: boolean ; externalDataSource: string }
Type declaration enabled: boolean external: string Permission Permission: { editable: boolean ; field: string ; readable?: boolean | null }
Type declaration editable: boolean field: string Optional readable?: boolean | null Permission Permission: { enabled: boolean ; flow: string }
Type declaration enabled: boolean flow: string Permission Permission
Set
Group
: Metadata & { description
?: string | null ; label
: string ; mutingPermissionSets
: string [] ; permissionSets
: string [] ; status
?: string | null } Permission Permission: { allowCreate: boolean ; allowDelete: boolean ; allowEdit: boolean ; allowRead: boolean ; modifyAllRecords: boolean ; object: string ; viewAllRecords: boolean }
Type declaration allow: boolean allow: boolean allow: boolean allow: boolean modify: boolean object: string view: boolean Permission Permission: { recordType: string ; visible: boolean }
Type declaration record: string visible: boolean Permission Permission: { tab: string ; visibility: string }
Type declaration tab: string visibility: string Permission Permission: { enabled: boolean ; name: string }
Type declaration enabled: boolean name: string Person Person
List
Settings
: Metadata & { enablePersonList
: boolean } Personalization Personalization: { groupName: string ; priority?: number | null ; targetType: string ; targetValue: string }
Type declaration group: string Optional priority?: number | null target: string target: string Personalization Picklist Picklist: { active: boolean ; defaultValue: boolean ; label: string ; validFor?: string | null ; value: string }
Type declaration active: boolean default: boolean label: string Optional valid?: string | null value: string Picklist Picklist
Settings
: Metadata & { isPicklistApiNameEditDisabled
?: boolean | null } Picklist Picklist
Value
: Metadata & { allowEmail
?: boolean | null ; closed
?: boolean | null ; color
?: string | null ; controllingFieldValues
: string [] ; converted
?: boolean | null ; cssExposed
?: boolean | null ; default
: boolean ; description
?: string | null ; forecastCategory
?: string | null ; highPriority
?: boolean | null ; isActive
?: boolean | null ; probability
?: number | null ; reverseRole
?: string | null ; reviewed
?: boolean | null ; won
?: boolean | null } Picklist Picklist: { masterLabel: string ; translation?: string | null }
Type declaration master: string Optional translation?: string | null Platform Platform: { actionName: string ; actionType: string ; sortOrder: number ; subtype?: string | null }
Type declaration action: string action: string sort: number Optional subtype?: string | null Platform Platform
Cache
Partition
: Metadata & { description
?: string | null ; isDefaultPartition
: boolean ; masterLabel
: string ; platformCachePartitionTypes
: PlatformCachePartitionType [] } Platform Platform: { allocatedCapacity: number ; allocatedPurchasedCapacity: number ; allocatedTrialCapacity: number ; cacheType: string }
Type declaration allocated: number allocated: number allocated: number cache: string Platform Platform
Encryption
Settings
: Metadata & { canEncryptManagedPackageFields
?: boolean | null ; enableDeterministicEncryption
?: boolean | null ; enableEncryptFieldHistory
?: boolean | null ; enableEventBusEncryption
?: boolean | null ; isMEKForEncryptionRequired
?: boolean | null ; isUseHighAssuranceKeysRequired
?: boolean | null } Platform Platform
Event
Channel
: Metadata & { channelType
: string ; label
: string } Platform Platform
Event
Channel
Member
: Metadata & { eventChannel
: string ; selectedEntity
: string } Portal Portal
: Metadata & { active
: boolean ; admin
?: string | null ; defaultLanguage
?: string | null ; description
?: string | null ; emailSenderAddress
: string ; emailSenderName
: string ; enableSelfCloseCase
?: boolean | null ; footerDocument
?: string | null ; forgotPassTemplate
?: string | null ; headerDocument
?: string | null ; isSelfRegistrationActivated
?: boolean | null ; loginHeaderDocument
?: string | null ; logoDocument
?: string | null ; logoutUrl
?: string | null ; newCommentTemplate
?: string | null ; newPassTemplate
?: string | null ; newUserTemplate
?: string | null ; ownerNotifyTemplate
?: string | null ; selfRegNewUserUrl
?: string | null ; selfRegUserDefaultProfile
?: string | null ; selfRegUserDefaultRole
?: string | null ; selfRegUserTemplate
?: string | null ; showActionConfirmation
?: boolean | null ; stylesheetDocument
?: string | null ; type
: string } Post Post
Template
: Metadata & { default
?: boolean | null ; description
?: string | null ; fields
: string [] ; label
: string } Presence Presence Presence: { profile: string [] }
Presence Presence: { user: string [] }
Presence Presence
Decline
Reason
: Metadata & { label
: string } Presence Presence
User
Config
: Metadata & { assignments
?: PresenceConfigAssignments | null ; capacity
: number ; declineReasons
: string [] ; enableAutoAccept
?: boolean | null ; enableDecline
?: boolean | null ; enableDeclineReason
?: boolean | null ; enableDisconnectSound
?: boolean | null ; enableRequestSound
?: boolean | null ; label
: string ; presenceStatusOnDecline
?: string | null ; presenceStatusOnPushTimeout
?: string | null } Primary Primary
Tab
Components
: { containers
: Container [] } Privacy Privacy
Settings
: Metadata & { enableConsentAuditTrail
?: boolean | null ; enableConsentEventStream
?: boolean | null ; enableDefaultMetadataValues
?: boolean | null } Private Private
Connection
: Metadata & { description
?: string | null ; direction
: string ; externalConnectionProperties
: ExternalConnectionProperty [] ; label
: string ; status
: string ; type
: string } Product Product
Settings
: Metadata & { enableCascadeActivateToRelatedPrices
?: boolean | null ; enableMySettings
?: boolean | null ; enableQuantitySchedule
?: boolean | null ; enableRevenueSchedule
?: boolean | null } Profile Profile: { actionName: string ; content?: string | null ; formFactor: string ; pageOrSobjectType: string ; recordType?: string | null ; type: string }
Type declaration action: string Optional content?: string | null form: string page: string Optional record?: string | null type: string Profile Profile: { apexClass: string ; enabled: boolean }
Type declaration apex: string enabled: boolean Profile Profile: { apexPage: string ; enabled: boolean }
Type declaration apex: string enabled: boolean Profile Profile: { application: string ; default: boolean ; visible: boolean }
Type declaration application: string default: boolean visible: boolean Profile Profile: { dataCategories: string [] ; dataCategoryGroup: string ; visibility: string }
Type declaration data: string [] data: string visibility: string Profile Profile: { enabled: boolean ; name: string }
Type declaration enabled: boolean name: string Profile Profile: { enabled: boolean ; name: string }
Type declaration enabled: boolean name: string Profile Profile: { enabled: boolean ; externalDataSource: string }
Type declaration enabled: boolean external: string Profile Profile: { editable: boolean ; field: string ; readable?: boolean | null }
Type declaration editable: boolean field: string Optional readable?: boolean | null Profile Profile: { enabled: boolean ; flow: string }
Type declaration enabled: boolean flow: string Profile Profile: { layout: string ; recordType?: string | null }
Type declaration layout: string Optional record?: string | null Profile Profile: { fridayEnd?: string | null ; fridayStart?: string | null ; mondayEnd?: string | null ; mondayStart?: string | null ; saturdayEnd?: string | null ; saturdayStart?: string | null ; sundayEnd?: string | null ; sundayStart?: string | null ; thursdayEnd?: string | null ; thursdayStart?: string | null ; tuesdayEnd?: string | null ; tuesdayStart?: string | null ; wednesdayEnd?: string | null ; wednesdayStart?: string | null }
Type declaration Optional friday?: string | null Optional friday?: string | null Optional monday?: string | null Optional monday?: string | null Optional saturday?: string | null Optional saturday?: string | null Optional sunday?: string | null Optional sunday?: string | null Optional thursday?: string | null Optional thursday?: string | null Optional tuesday?: string | null Optional tuesday?: string | null Optional wednesday?: string | null Optional wednesday?: string | null Profile Profile: { description?: string | null ; endAddress: string ; startAddress: string }
Type declaration Optional description?: string | null end: string start: string Profile Profile: { allowCreate?: boolean | null ; allowDelete?: boolean | null ; allowEdit?: boolean | null ; allowRead?: boolean | null ; modifyAllRecords?: boolean | null ; object: string ; viewAllRecords?: boolean | null }
Type declaration Optional allow?: boolean | null Optional allow?: boolean | null Optional allow?: boolean | null Optional allow?: boolean | null Optional modify?: boolean | null object: string Optional view?: boolean | null Profile Profile
Password
Policy
: Metadata & { forgotPasswordRedirect
?: boolean | null ; lockoutInterval
: number ; maxLoginAttempts
: number ; minimumPasswordLength
: number ; minimumPasswordLifetime
?: boolean | null ; obscure
?: boolean | null ; passwordComplexity
: number ; passwordExpiration
: number ; passwordHistory
: number ; passwordQuestion
: number ; profile
: string } Profile Profile: { default: boolean ; personAccountDefault?: boolean | null ; recordType: string ; visible: boolean }
Type declaration default: boolean Optional person?: boolean | null record: string visible: boolean Profile Profile: { fields: string [] ; profileName?: string | null }
Type declaration fields: string [] Optional profile?: string | null Profile Profile
Session
Setting
: Metadata & { externalCommunityUserIdentityVerif
: boolean ; forceLogout
: boolean ; profile
: string ; requiredSessionLevel
?: string | null ; sessionPersistence
: boolean ; sessionTimeout
: number ; sessionTimeoutWarning
: boolean } Profile Profile: { tab: string ; visibility: string }
Type declaration tab: string visibility: string Profile Profile: { enabled: boolean ; name: string }
Type declaration enabled: boolean name: string Prompt Prompt
Version
: { actionButtonLabel
?: string | null ; actionButtonLink
?: string | null ; body
: string ; customApplication
?: string | null ; delayDays
: number ; description
?: string | null ; dismissButtonLabel
?: string | null ; displayPosition
?: string | null ; displayType
: string ; endDate
?: string | null ; header
?: string | null ; indexWithIsPublished
?: string | null ; indexWithoutIsPublished
?: string | null ; isPublished
?: boolean | null ; masterLabel
: string ; publishedByUser
?: string | null ; publishedDate
?: string | null ; shouldDisplayActionButton
: boolean ; startDate
: string ; targetAppDeveloperName
: string ; targetAppNamespacePrefix
?: string | null ; targetPageKey1
: string ; targetPageKey2
?: string | null ; targetPageType
: string ; timesToDisplay
: number ; title
: string ; uiFormulaRule
?: UiFormulaRule | null ; userAccess
: string ; versionNumber
: number } Type declaration Optional action?: string | null Optional action?: string | null body: string Optional custom?: string | null delay: number Optional description?: string | null Optional dismiss?: string | null Optional display?: string | null display: string Optional end?: string | null Optional header?: string | null Optional index?: string | null Optional index?: string | null Optional is?: boolean | null master: string Optional published?: string | null Optional published?: string | null should: boolean start: string target: string Optional target?: string | null target: string Optional target?: string | null target: string times: number title: string Optional ui?: UiFormulaRule | null user: string version: number Public Public: { publicGroup: string [] }
Push Push: { fieldNames: string [] ; objectName: string }
Type declaration field: string [] object: string Queue Queue
: Metadata & { doesSendEmailToMembers
?: boolean | null ; email
?: string | null ; name
: string ; queueMembers
?: QueueMembers | null ; queueRoutingConfig
?: string | null ; queueSobject
: QueueSobject [] } Queue Queue
Routing
Config
: Metadata & { capacityPercentage
?: number | null ; capacityWeight
?: number | null ; dropAdditionalSkillsTimeout
?: number | null ; isAttributeBased
?: boolean | null ; label
: string ; pushTimeout
?: number | null ; queueOverflowAssignee
?: string | null ; routingModel
: string ; routingPriority
: number ; userOverflowAssignee
?: string | null } Queue Queue: { sobjectType: string }
Quick Quick
Action
: Metadata & { canvas
?: string | null ; description
?: string | null ; fieldOverrides
: FieldOverride [] ; flowDefinition
?: string | null ; height
?: number | null ; icon
?: string | null ; isProtected
?: boolean | null ; label
?: string | null ; lightningComponent
?: string | null ; mobExtDisplayMode
?: string | null ; optionsCreateFeedItem
: boolean ; page
?: string | null ; quickActionLayout
?: QuickActionLayout | null ; quickActionSendEmailOptions
?: QuickActionSendEmailOptions | null ; standardLabel
?: string | null ; successMessage
?: string | null ; targetObject
?: string | null ; targetParentField
?: string | null ; targetRecordType
?: string | null ; type
: string ; width
?: number | null } Quick Type declaration layout: string Quick Quick: { emptySpace?: boolean | null ; field?: string | null ; uiBehavior?: string | null }
Type declaration Optional empty?: boolean | null Optional field?: string | null Optional ui?: string | null Quick Quick: { quickActionName: string }
Quick Quick: { defaultEmailTemplateName?: string | null ; ignoreDefaultEmailTemplateSubject: boolean }
Type declaration Optional default?: string | null ignore: boolean Quick Quick: { label: string ; name: string }
Type declaration label: string name: string Quotas Quotas: { showQuotas: boolean }
Quote Quote
Settings
: Metadata & { enableQuote
: boolean ; enableQuotesWithoutOppEnabled
?: boolean | null } Recommendation Recommendation: { audienceCriteriaType?: string | null ; audienceCriteriaValue?: string | null ; setupName?: string | null }
Type declaration Optional audience?: string | null Optional audience?: string | null Optional setup?: string | null Recommendation Recommendation: { type: string ; value?: string | null }
Type declaration type: string Optional value?: string | null Recommendation Recommendation
Definition
Detail
: { actionUrl
?: string | null ; description
?: string | null ; linkText
?: string | null ; scheduledRecommendations
?: ScheduledRecommendation | null ; setupName
?: string | null ; title
?: string | null } Type declaration Optional action?: string | null Optional description?: string | null Optional link?: string | null Optional setup?: string | null Optional title?: string | null Recommendation Type declaration field: string operator: string Record Record: { action: string ; isMandatory?: boolean | null ; isUiRemoveHidden?: boolean | null ; pinned: string ; position: number ; type: string }
Type declaration action: string Optional is?: boolean | null Optional is?: boolean | null pinned: string position: number type: string Record Record
Action
Deployment
Channel
: { channel
: string ; channelItems
: RecordActionDefaultItem [] ; isAutopopEnabled
?: boolean | null } Type declaration channel: string Optional is?: boolean | null Record Record: { entityName: string ; recommendationStrategy?: string | null }
Type declaration entity: string Optional recommendation?: string | null Record Record: { defaultStrategy?: string | null ; hasDescription: boolean ; hasImage: boolean ; hasRejectAction: boolean ; hasTitle: boolean ; maxDisplayRecommendations: number }
Type declaration Optional default?: string | null has: boolean has: boolean has: boolean has: boolean max: number Record Record: { action: string ; type: string }
Type declaration action: string type: string Record Record
Page
Settings
: Metadata & { enableActivityRelatedList
?: boolean | null ; enableFullRecordView
?: boolean | null } Record Record
Type
: Metadata & { active
: boolean ; businessProcess
?: string | null ; compactLayoutAssignment
?: string | null ; description
?: string | null ; label
: string ; picklistValues
: RecordTypePicklistValue [] } Record Record
Type
Picklist
Value
: { picklist
: string ; values
: PicklistValue [] } Record Record: { description?: string | null ; label: string ; name: string }
Type declaration Optional description?: string | null label: string name: string Related Related: { hideOnDetail: boolean ; name: string }
Type declaration hide: boolean name: string Related Related: { customButtons: string [] ; excludeButtons: string [] ; fields: string [] ; relatedList: string ; sortField?: string | null ; sortOrder?: string | null }
Type declaration custom: string [] exclude: string [] fields: string [] related: string Optional sort?: string | null Optional sort?: string | null Remote Remote
Site
Setting
: Metadata & { description
?: string | null ; disableProtocolSecurity
: boolean ; isActive
: boolean ; url
: string } Report Report: { acrossGroupingContext?: string | null ; calculatedFormula: string ; datatype: string ; description?: string | null ; developerName: string ; downGroupingContext?: string | null ; isActive: boolean ; isCrossBlock?: boolean | null ; masterLabel: string ; reportType?: string | null ; scale?: number | null }
Type declaration Optional across?: string | null calculated: string datatype: string Optional description?: string | null developer: string Optional down?: string | null is: boolean Optional is?: boolean | null master: string Optional report?: string | null Optional scale?: number | null Report Report: { aggregate: string }
Report Type declaration block: string join: string Report Report
Bucket
Field
: { bucketType
: string ; developerName
: string ; masterLabel
: string ; nullTreatment
?: string | null ; otherBucketLabel
?: string | null ; sourceColumnName
: string ; useOther
?: boolean | null ; values
: ReportBucketFieldValue [] } Type declaration bucket: string developer: string master: string Optional null?: string | null Optional other?: string | null source: string Optional use?: boolean | null Report Report: { from?: string | null ; sourceValue?: string | null ; to?: string | null }
Type declaration Optional from?: string | null Optional source?: string | null Optional to?: string | null Report Report
Chart
: { backgroundColor1
?: string | null ; backgroundColor2
?: string | null ; backgroundFadeDir
?: string | null ; chartSummaries
: ChartSummary [] ; chartType
: string ; enableHoverLabels
?: boolean | null ; expandOthers
?: boolean | null ; groupingColumn
?: string | null ; legendPosition
?: string | null ; location
?: string | null ; secondaryGroupingColumn
?: string | null ; showAxisLabels
?: boolean | null ; showPercentage
?: boolean | null ; showTotal
?: boolean | null ; showValues
?: boolean | null ; size
?: string | null ; summaryAxisManualRangeEnd
?: number | null ; summaryAxisManualRangeStart
?: number | null ; summaryAxisRange
?: string | null ; textColor
?: string | null ; textSize
?: number | null ; title
?: string | null ; titleColor
?: string | null ; titleSize
?: number | null } Type declaration Optional background?: string | null Optional background?: string | null Optional background?: string | null chart: string Optional enable?: boolean | null Optional expand?: boolean | null Optional grouping?: string | null Optional legend?: string | null Optional location?: string | null Optional secondary?: string | null Optional show?: boolean | null Optional show?: boolean | null Optional show?: boolean | null Optional show?: boolean | null Optional size?: string | null Optional summary?: number | null Optional summary?: number | null Optional summary?: string | null Optional text?: string | null Optional text?: number | null Optional title?: string | null Optional title?: string | null Optional title?: number | null Report Report: { cacheData?: boolean | null ; contextFilterableField?: string | null ; error?: string | null ; hideOnError?: boolean | null ; includeContext?: boolean | null ; reportName: string ; showTitle?: boolean | null ; size?: string | null }
Type declaration Optional cache?: boolean | null Optional context?: string | null Optional error?: string | null Optional hide?: boolean | null Optional include?: boolean | null report: string Optional show?: boolean | null Optional size?: string | null Report Report: { aggregate?: string | null ; columnName: string ; highBreakpoint?: number | null ; highColor: string ; lowBreakpoint?: number | null ; lowColor: string ; midColor: string }
Type declaration Optional aggregate?: string | null column: string Optional high?: number | null high: string Optional low?: number | null low: string mid: string Report Report: { aggregateTypes: string [] ; field: string ; reverseColors?: boolean | null ; showChanges?: boolean | null }
Type declaration aggregate: string [] field: string Optional reverse?: boolean | null Optional show?: boolean | null Report Report
Cross
Filter
: { criteriaItems
: ReportFilterItem [] ; operation
: string ; primaryTableColumn
: string ; relatedTable
: string ; relatedTableJoinColumn
: string } Type declaration operation: string primary: string related: string related: string Report Report: { calculatedFormula: string ; dataType: string ; description?: string | null ; developerName: string ; label: string ; scale: number }
Type declaration calculated: string data: string Optional description?: string | null developer: string label: string scale: number Report Report: { dataCategory: string ; dataCategoryGroup: string ; operator: string }
Type declaration data: string data: string operator: string Report Report
Filter
: { booleanFilter
?: string | null ; criteriaItems
: ReportFilterItem [] ; language
?: string | null } Type declaration Optional boolean?: string | null Optional language?: string | null Report Report: { column: string ; columnToColumn?: boolean | null ; isUnlocked?: boolean | null ; operator: string ; snapshot?: string | null ; value?: string | null }
Type declaration column: string Optional column?: boolean | null Optional is?: boolean | null operator: string Optional snapshot?: string | null Optional value?: string | null Report Type declaration Optional aggregate?: string | null column: string Report Report: { backgroundColor?: string | null ; rangeUpperBound?: number | null }
Type declaration Optional background?: string | null Optional range?: number | null Report Report: { aggregateType?: string | null ; dateGranularity?: string | null ; field: string ; sortByName?: string | null ; sortOrder: string ; sortType?: string | null }
Type declaration Optional aggregate?: string | null Optional date?: string | null field: string Optional sort?: string | null sort: string Optional sort?: string | null Report Report: { snapshot: string [] }
Report Report: { name: string ; value: string }
Type declaration name: string value: string Report Report: { dateColumn: string ; endDate?: string | null ; interval: string ; startDate?: string | null }
Type declaration date: string Optional end?: string | null interval: string Optional start?: string | null Report Report
Type
: Metadata & { autogenerated
?: boolean | null ; baseObject
: string ; category
: string ; deployed
: boolean ; description
?: string | null ; join
?: ObjectRelationship | null ; label
: string ; sections
: ReportLayoutSection [] } Report Report: { checkedByDefault: boolean ; displayNameOverride?: string | null ; field: string ; table: string }
Type declaration checked: boolean Optional display?: string | null field: string table: string Report Report: { label: string ; name: string }
Type declaration label: string name: string Report Type declaration Optional label?: string | null name: string Report Type declaration Optional description?: string | null Optional label?: string | null name: string Reputation Reputation: { smallImage?: string | null }
Type declaration Optional small?: string | null Reputation Reputation
Level
: { branding
?: ReputationBranding | null ; label
?: string | null ; lowerThreshold
: number } Type declaration Optional label?: string | null lower: number Reputation Reputation Reputation: { eventType: string ; points: number }
Type declaration event: string points: number Restriction Restriction
Rule
: Metadata & { active
: boolean ; description
: string ; enforcementType
: string ; masterLabel
: string ; recordFilter
: string ; targetEntity
: string ; userCriteria
: string ; version
: number } Retail Retail
Execution
Settings
: Metadata & { enableRetailExecution
?: boolean | null } Retrieve Retrieve: { fileName: string ; problem: string }
Type declaration file: string problem: string Retrieve Retrieve
Request
: { apiVersion
: number ; packageNames
: string [] ; singlePackage
: boolean ; specificFiles
: string [] ; unpackaged
?: Package | null } Type declaration api: number package: string [] single: boolean specific: string [] Optional unpackaged?: Package | null Retrieve Retrieve
Result
: { done
: boolean ; errorMessage
?: string | null ; errorStatusCode
?: string | null ; fileProperties
: FileProperties [] ; id
: string ; messages
: RetrieveMessage [] ; status
: string ; success
: boolean ; zipFile
: string } Type declaration done: boolean Optional error?: string | null Optional error?: string | null id: string status: string success: boolean zip: string Role Role: { roleAndSubordinate: string [] }
Type declaration role: string [] Role Role: { roleAndSubordinateInternal: string [] }
Type declaration role: string [] Role Role
Or
Territory
: Metadata & { caseAccessLevel
?: string | null ; contactAccessLevel
?: string | null ; description
?: string | null ; mayForecastManagerShare
?: boolean | null ; name
: string ; opportunityAccessLevel
?: string | null } Roles Roles: { role: string [] }
Rule Rule
Entry
: { assignedTo
?: string | null ; assignedToType
?: string | null ; booleanFilter
?: string | null ; businessHours
?: string | null ; businessHoursSource
?: string | null ; criteriaItems
: FilterItem [] ; disableEscalationWhenModified
?: boolean | null ; escalationAction
: EscalationAction [] ; escalationStartTime
?: string | null ; formula
?: string | null ; notifyCcRecipients
?: boolean | null ; overrideExistingTeams
?: boolean | null ; replyToEmail
?: string | null ; senderEmail
?: string | null ; senderName
?: string | null ; team
: string [] ; template
?: string | null } Type declaration Optional assigned?: string | null Optional assigned?: string | null Optional boolean?: string | null Optional business?: string | null Optional business?: string | null Optional disable?: boolean | null Optional escalation?: string | null Optional formula?: string | null Optional notify?: boolean | null Optional override?: boolean | null Optional reply?: string | null Optional sender?: string | null Optional sender?: string | null team: string [] Optional template?: string | null Run Run: { id: string ; message: string ; methodName?: string | null ; name: string ; namespace?: string | null ; packageName: string ; seeAllData?: boolean | null ; stackTrace?: string | null ; time: number ; type: string }
Type declaration id: string message: string Optional method?: string | null name: string Optional namespace?: string | null package: string Optional see?: boolean | null Optional stack?: string | null time: number type: string Run Run: { id: string ; methodName: string ; name: string ; namespace?: string | null ; seeAllData?: boolean | null ; time: number }
Type declaration id: string method: string name: string Optional namespace?: string | null Optional see?: boolean | null time: number Run Type declaration Optional apex?: string | null num: number num: number total: number Saml Saml
Sso
Config
: Metadata & { attributeName
?: string | null ; attributeNameIdFormat
?: string | null ; decryptionCertificate
?: string | null ; errorUrl
?: string | null ; executionUserId
?: string | null ; identityLocation
: string ; identityMapping
: string ; issuer
: string ; loginUrl
?: string | null ; logoutUrl
?: string | null ; name
: string ; oauthTokenEndpoint
?: string | null ; redirectBinding
?: boolean | null ; requestSignatureMethod
?: string | null ; requestSigningCertId
?: string | null ; salesforceLoginUrl
?: string | null ; samlEntityId
: string ; samlJitHandlerId
?: string | null ; samlVersion
: string ; singleLogoutBinding
?: string | null ; singleLogoutUrl
?: string | null ; userProvisioning
?: boolean | null ; validationCert
: string } Save Save
Result
: { errors
: Error [] ; fullName
: string ; success
: boolean } Type declaration full: string success: boolean Scheduled Scheduled: { channel?: string | null ; enabled?: boolean | null ; rank?: number | null ; recommendationAudience?: string | null }
Type declaration Optional channel?: string | null Optional enabled?: boolean | null Optional rank?: number | null Optional recommendation?: string | null Schema Schema
Settings
: Metadata & { enableAdvancedCMTSecurity
?: boolean | null ; enableAdvancedCSSecurity
?: boolean | null ; enableListCustomSettingCreation
?: boolean | null ; enableSOSLOnCustomSettings
?: boolean | null } Scontrol Scontrol
: MetadataWithContent & { contentSource
: string ; description
?: string | null ; encodingKey
: string ; fileContent
?: string | null ; fileName
?: string | null ; name
: string ; supportsCaching
: boolean } Scontrol Scontrol: { label: string ; name: string }
Type declaration label: string name: string Search Search: { customTabListAdditionalFields: string [] ; excludedStandardButtons: string [] ; listViewButtons: string [] ; lookupDialogsAdditionalFields: string [] ; lookupFilterFields: string [] ; lookupPhoneDialogsAdditionalFields: string [] ; massQuickActions: string [] ; searchFilterFields: string [] ; searchResultsAdditionalFields: string [] ; searchResultsCustomButtons: string [] }
Type declaration custom: string [] excluded: string [] list: string [] lookup: string [] lookup: string [] lookup: string [] mass: string [] search: string [] search: string [] search: string [] Search Search
Settings
: Metadata & { documentContentSearchEnabled
: boolean ; enableAdvancedSearchInAlohaSidebar
?: boolean | null ; enableEinsteinSearchPersonalization
?: boolean | null ; enableQuerySuggestionPigOn
?: boolean | null ; enableSalesforceGeneratedSynonyms
?: boolean | null ; enableSetupSearch
?: boolean | null ; optimizeSearchForCJKEnabled
: boolean ; recentlyViewedUsersForBlankLookupEnabled
: boolean ; searchSettingsByObject
: SearchSettingsByObject ; sidebarAutoCompleteEnabled
: boolean ; sidebarDropDownListEnabled
: boolean ; sidebarLimitToItemsIOwnCheckboxEnabled
: boolean ; singleSearchResultShortcutEnabled
: boolean ; spellCorrectKnowledgeSearchEnabled
: boolean } Security Security
Settings
: Metadata & { canUsersGrantLoginAccess
?: boolean | null ; enableAdminLoginAsAnyUser
?: boolean | null ; enableAuditFieldsInactiveOwner
?: boolean | null ; enableAuraSecureEvalPref
?: boolean | null ; enableRequireHttpsConnection
?: boolean | null ; isTLSv12Required
?: boolean | null ; isTLSv12RequiredCommunities
?: boolean | null ; networkAccess
?: NetworkAccess | null ; passwordPolicies
?: PasswordPolicies | null ; sessionSettings
?: SessionSettings | null ; singleSignOnSettings
?: SingleSignOnSettings | null } Service Service
Channel
: Metadata & { interactionComponent
?: string | null ; label
: string ; relatedEntityType
: string ; secondaryRoutingPriorityField
?: string | null ; serviceChannelFieldPriorities
: ServiceChannelFieldPriority [] } Service Service: { priority: number ; value: string }
Type declaration priority: number value: string Service Service: { channel: string [] }
Service Type declaration detail: string Optional footer?: string | null Optional header?: string | null list: string Optional live?: LiveAgentConfig | null Optional primary?: string | null Optional tab?: TabLimitConfig | null whitelisted: string [] Session Session: { allowUserAuthenticationByCertificate?: boolean | null ; canConfirmEmailChangeInLightningCommunities?: boolean | null ; disableTimeoutWarning?: boolean | null ; enableCSPOnEmail?: boolean | null ; enableCSRFOnGet?: boolean | null ; enableCSRFOnPost?: boolean | null ; enableCacheAndAutocomplete?: boolean | null ; enableClickjackNonsetupSFDC?: boolean | null ; enableClickjackNonsetupUser?: boolean | null ; enableClickjackNonsetupUserHeaderless?: boolean | null ; enableClickjackSetup?: boolean | null ; enableContentSniffingProtection?: boolean | null ; enableLightningLogin?: boolean | null ; enableLightningLoginOnlyWithUserPerm?: boolean | null ; enablePostForSessions?: boolean | null ; enableSMSIdentity?: boolean | null ; enableU2F?: boolean | null ; enableUpgradeInsecureRequests?: boolean | null ; enableXssProtection?: boolean | null ; enforceIpRangesEveryRequest?: boolean | null ; forceLogoutOnSessionTimeout?: boolean | null ; forceRelogin?: boolean | null ; hasRetainedLoginHints?: boolean | null ; hasUserSwitching?: boolean | null ; hstsOnForcecomSites?: boolean | null ; identityConfirmationOnEmailChange?: boolean | null ; identityConfirmationOnTwoFactorRegistrationEnabled?: boolean | null ; lockSessionsToDomain?: boolean | null ; lockSessionsToIp?: boolean | null ; lockerServiceAPIVersion?: string | null ; lockerServiceCSP?: boolean | null ; lockerServiceFrozenRealm?: boolean | null ; logoutURL?: string | null ; redirectionWarning?: boolean | null ; referrerPolicy?: boolean | null ; requireHttpOnly?: boolean | null ; requireHttps?: boolean | null ; securityCentralKillSession?: boolean | null ; sessionTimeout?: string | null }
Type declaration Optional allow?: boolean | null Optional can?: boolean | null Optional disable?: boolean | null Optional enableCSPOn?: boolean | null Optional enableCSRFOn?: boolean | null Optional enableCSRFOn?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enableSMSIdentity?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enforce?: boolean | null Optional force?: boolean | null Optional force?: boolean | null Optional has?: boolean | null Optional has?: boolean | null Optional hsts?: boolean | null Optional identity?: boolean | null Optional identity?: boolean | null Optional lock?: boolean | null Optional lock?: boolean | null Optional locker?: string | null Optional locker?: boolean | null Optional locker?: boolean | null Optional logoutURL?: string | null Optional redirection?: boolean | null Optional referrer?: boolean | null Optional require?: boolean | null Optional require?: boolean | null Optional security?: boolean | null Optional session?: string | null Shared Shared: { allCustomerPortalUsers?: string | null ; allInternalUsers?: string | null ; allPartnerUsers?: string | null ; channelProgramGroup: string [] ; channelProgramGroups: string [] ; group: string [] ; groups: string [] ; guestUser: string [] ; managerSubordinates: string [] ; managers: string [] ; portalRole: string [] ; portalRoleAndSubordinates: string [] ; queue: string [] ; role: string [] ; roleAndSubordinates: string [] ; roleAndSubordinatesInternal: string [] ; roles: string [] ; rolesAndSubordinates: string [] ; territories: string [] ; territoriesAndSubordinates: string [] ; territory: string [] ; territoryAndSubordinates: string [] }
Type declaration Optional all?: string | null Optional all?: string | null Optional all?: string | null channel: string [] channel: string [] group: string [] groups: string [] guest: string [] manager: string [] managers: string [] portal: string [] portal: string [] queue: string [] role: string [] role: string [] role: string [] roles: string [] roles: string [] territories: string [] territories: string [] territory: string [] territory: string [] Sharing Sharing
Reason
: Metadata & { label
: string } Sharing Sharing: { label: string ; name: string }
Type declaration label: string name: string Sharing Sharing: { className: string }
Sharing Sharing
Set
: Metadata & { accessMappings
: AccessMapping [] ; description
?: string | null ; name
: string ; profiles
: string [] } Sharing Sharing
Settings
: Metadata & { enableAccountRoleOptimization
?: boolean | null ; enableAssetSharing
?: boolean | null ; enableCommunityUserVisibility
?: boolean | null ; enableExternalSharingModel
?: boolean | null ; enableManagerGroups
?: boolean | null ; enableManualUserRecordSharing
?: boolean | null ; enablePartnerSuperUserAccess
?: boolean | null ; enablePortalUserCaseSharing
?: boolean | null ; enablePortalUserVisibility
?: boolean | null ; enableRemoveTMGroupMembership
?: boolean | null ; enableSecureGuestAccess
?: boolean | null ; enableStandardReportVisibility
?: boolean | null ; enableTerritoryForecastManager
?: boolean | null } Sidebar Sidebar
Component
: { componentType
: string ; createAction
?: string | null ; enableLinking
?: boolean | null ; height
?: number | null ; label
?: string | null ; lookup
?: string | null ; page
?: string | null ; relatedLists
: RelatedList [] ; unit
?: string | null ; updateAction
?: string | null ; width
?: number | null } Type declaration component: string Optional create?: string | null Optional enable?: boolean | null Optional height?: number | null Optional label?: string | null Optional lookup?: string | null Optional page?: string | null Optional unit?: string | null Optional update?: string | null Optional width?: number | null Single Single: { enableForceDelegatedCallout?: boolean | null ; enableMultipleSamlConfigs?: boolean | null ; enableSamlJitProvisioning?: boolean | null ; enableSamlLogin?: boolean | null }
Type declaration Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Optional enable?: boolean | null Site Site: { action: string ; isActive?: boolean | null ; source: string ; target: string }
Type declaration action: string Optional is?: boolean | null source: string target: string Site Site
Settings
: Metadata & { enableProxyLoginICHeader
?: boolean | null ; enableTopicsInSites
?: boolean | null ; enableVisualforceApiAccessAllowed
?: boolean | null } Site Site: { certificate?: string | null ; domainName: string ; primary: boolean }
Type declaration Optional certificate?: string | null domain: string primary: boolean Skill Skill: { profile: string [] }
Skill Skill: { user: string [] }
Social Social
Customer
Service
Settings
: Metadata & { caseSubjectOption
: string ; enableSocialApprovals
?: boolean | null ; enableSocialCaseAssignmentRules
?: boolean | null ; enableSocialCustomerService
?: boolean | null ; enableSocialPersonaHistoryTracking
?: boolean | null ; enableSocialPostHistoryTracking
?: boolean | null ; enableSocialReceiveParentPost
?: boolean | null } Social Social
Profile
Settings
: Metadata & { enableSocialProfiles
?: boolean | null ; isFacebookSocialProfilesDisabled
?: boolean | null ; isLinkedInSocialProfilesDisabled
?: boolean | null ; isTwitterSocialProfilesDisabled
?: boolean | null ; isYouTubeSocialProfilesDisabled
?: boolean | null } Source Source
Tracking
Settings
: Metadata & { enableSourceTrackingSandboxes
?: boolean | null } Standard Standard: { label?: string | null ; name: string }
Type declaration Optional label?: string | null name: string Standard Standard
Value
: CustomValue & { allowEmail
?: boolean | null ; closed
?: boolean | null ; converted
?: boolean | null ; cssExposed
?: boolean | null ; forecastCategory
?: string | null ; groupingString
?: string | null ; highPriority
?: boolean | null ; probability
?: number | null ; reverseRole
?: string | null ; reviewed
?: boolean | null ; won
?: boolean | null } Standard Standard
Value
Set
: Metadata & { groupingStringEnum
?: string | null ; sorted
: boolean ; standardValue
: StandardValue [] } Standard State State: { active: boolean ; integrationValue: string ; isoCode: string ; label: string ; standard: boolean ; visible: boolean }
Type declaration active: boolean integration: string iso: string label: string standard: boolean visible: boolean Static Static
Resource
: MetadataWithContent & { cacheControl
: string ; contentType
: string ; description
?: string | null } Strategy Strategy
Action
: { action
: string ; argument
: StrategyActionArg [] ; description
?: string | null ; label
?: string | null ; name
: string ; type
: string } Type declaration action: string Optional description?: string | null Optional label?: string | null name: string type: string Strategy Strategy: { name: string ; value: string }
Type declaration name: string value: string Strategy Strategy: { childNode: string [] ; description?: string | null ; label?: string | null ; name: string }
Type declaration child: string [] Optional description?: string | null Optional label?: string | null name: string Strategy Strategy Strategy: { name: string ; value: string }
Type declaration name: string value: string Strategy Strategy
Node
Recommendation
Limit
: StrategyNodeUnionBase & { filterMode
: string [] ; lookbackDuration
?: number | null ; maxRecommendationCount
?: number | null } Strategy Strategy Strategy: { name: string ; nullsFirst?: boolean | null ; order?: string | null }
Type declaration name: string Optional nulls?: boolean | null Optional order?: string | null Subtab Subtab
Components
: { containers
: Container [] } Summary Summary
Layout
: { masterLabel
: string ; sizeX
: number ; sizeY
?: number | null ; sizeZ
?: number | null ; summaryLayoutItems
: SummaryLayoutItem [] ; summaryLayoutStyle
: string } Type declaration master: string sizeX: number Optional sizeY?: number | null Optional sizeZ?: number | null summary: string Summary Summary: { customLink?: string | null ; field?: string | null ; posX: number ; posY?: number | null ; posZ?: number | null }
Type declaration Optional custom?: string | null Optional field?: string | null posX: number Optional posY?: number | null Optional posZ?: number | null Supervisor Supervisor: { skill: string [] }
Survey Survey
Settings
: Metadata & { enableSurvey
?: boolean | null ; enableSurveyOwnerCanManageResponse
?: boolean | null } Synonym Synonym
Dictionary
: Metadata & { groups
: SynonymGroup [] ; isProtected
?: boolean | null ; label
: string } Synonym Synonym: { languages: string [] ; terms: string [] }
Type declaration languages: string [] terms: string [] System System
Notification
Settings
: Metadata & { disableDowntimeNotifications
?: boolean | null ; disableMaintenanceNotifications
?: boolean | null } Tab Tab: { maxNumberOfPrimaryTabs?: string | null ; maxNumberOfSubTabs?: string | null }
Type declaration Optional max?: string | null Optional max?: string | null Targets Targets: { target: string [] }
Territory Territory
: RoleOrTerritory & { accountAccessLevel
?: string | null ; parentTerritory
?: string | null } Territory2 Territory2
: Metadata & { accountAccessLevel
?: string | null ; caseAccessLevel
?: string | null ; contactAccessLevel
?: string | null ; customFields
: FieldValue [] ; description
?: string | null ; name
: string ; opportunityAccessLevel
?: string | null ; parentTerritory
?: string | null ; ruleAssociations
: Territory2RuleAssociation [] ; territory2Type
: string } Territory2 Territory2
Model
: Metadata & { customFields
: FieldValue [] ; description
?: string | null ; name
: string } Territory2 Territory2
Rule
: Metadata & { active
: boolean ; booleanFilter
?: string | null ; name
: string ; objectType
: string ; ruleItems
: Territory2RuleItem [] } Territory2 Territory2: { inherited: boolean ; ruleName: string }
Type declaration inherited: boolean rule: string Territory2 Territory2: { field: string ; operation: string ; value?: string | null }
Type declaration field: string operation: string Optional value?: string | null Territory2 Territory2
Settings
: Metadata & { defaultAccountAccessLevel
?: string | null ; defaultCaseAccessLevel
?: string | null ; defaultContactAccessLevel
?: string | null ; defaultOpportunityAccessLevel
?: string | null ; enableTerritoryManagement2
?: boolean | null ; opportunityFilterSettings
?: Territory2SettingsOpportunityFilter | null } Territory2 Territory2: { apexClassName?: string | null ; enableFilter: boolean ; runOnCreate: boolean }
Type declaration Optional apex?: string | null enable: boolean run: boolean Territory2 Territory2
Type
: Metadata & { description
?: string | null ; name
: string ; priority
: number } Time Time
Sheet
Template
: Metadata & { active
: boolean ; description
?: string | null ; frequency
: string ; masterLabel
: string ; startDate
: string ; timeSheetTemplateAssignments
: TimeSheetTemplateAssignment [] ; workWeekEndDay
: string ; workWeekStartDay
: string } Time Time: { assignedTo?: string | null }
Type declaration Optional assigned?: string | null Topics Topics
For
Objects
: Metadata & { enableTopics
: boolean ; entityApiName
: string } Trailhead Trailhead
Settings
: Metadata & { enableMyTrailheadPref
?: boolean | null } Transaction Transaction
Security
Action
: { block
: boolean ; endSession
: boolean ; freezeUser
: boolean ; notifications
: TransactionSecurityNotification [] ; twoFactorAuthentication
: boolean } Type declaration block: boolean end: boolean freeze: boolean two: boolean Transaction Transaction: { inApp: boolean ; sendEmail: boolean ; user: string }
Type declaration in: boolean send: boolean user: string Transaction Transaction
Security
Policy
: Metadata & { action
: TransactionSecurityAction ; active
: boolean ; apexClass
?: string | null ; description
?: string | null ; developerName
?: string | null ; eventName
?: string | null ; eventType
?: string | null ; executionUser
?: string | null ; flow
?: string | null ; masterLabel
?: string | null ; resourceName
?: string | null ; type
?: string | null } UIObject UIObject
Relation
Config
: Metadata & { UIObjectRelationFieldConfigs
: UIObjectRelationFieldConfig [] ; contextObject
: string ; contextObjectRecordType
?: string | null ; directRelationshipField
?: string | null ; indirectObjectContextField
?: string | null ; indirectObjectRelatedField
?: string | null ; indirectRelationshipObject
?: string | null ; isActive
: boolean ; masterLabel
: string ; relatedObject
: string ; relatedObjectRecordType
?: string | null ; relationshipType
: string } UIObject UIObject: { displayLabel: string ; queryText: string ; rowOrder: number }
Type declaration display: string query: string row: number Ui Ui: { leftValue: string ; operator: string ; rightValue?: string | null }
Type declaration left: string operator: string Optional right?: string | null Ui Type declaration Optional boolean?: string | null Ui Ui
Plugin
: MetadataWithContent & { description
?: string | null ; extensionPointIdentifier
: string ; isEnabled
: boolean ; language
: string ; masterLabel
: string } Upsert Upsert
Result
: { created
: boolean ; errors
: Error [] ; fullName
: string ; success
: boolean } Type declaration created: boolean full: string success: boolean User User
Criteria
: Metadata & { creationAgeInSeconds
?: number | null ; description
?: string | null ; lastChatterActivityAgeInSeconds
?: number | null ; masterLabel
: string ; profiles
: string [] ; userTypes
: string [] } User User
Engagement
Settings
: Metadata & { canGovCloudUseAdoptionApps
?: boolean | null ; doesScheduledSwitcherRunDaily
?: boolean | null ; enableCustomHelpGlobalSection
?: boolean | null ; enableHelpMenuShowFeedback
?: boolean | null ; enableHelpMenuShowHelp
?: boolean | null ; enableHelpMenuShowNewUser
?: boolean | null ; enableHelpMenuShowSearch
?: boolean | null ; enableHelpMenuShowSfdcContent
?: boolean | null ; enableHelpMenuShowShortcut
?: boolean | null ; enableHelpMenuShowSupport
?: boolean | null ; enableHelpMenuShowTrailhead
?: boolean | null ; enableIBILOptOutDashboards
?: boolean | null ; enableIBILOptOutEvents
?: boolean | null ; enableIBILOptOutReports
?: boolean | null ; enableIBILOptOutTasks
?: boolean | null ; enableLexToClassicFeedbackEnable
?: boolean | null ; enableOrchestrationInSandbox
?: boolean | null ; enableOrgUserAssistEnabled
?: boolean | null ; enableScheduledSwitcher
?: boolean | null ; enableSfdcProductFeedbackSurvey
?: boolean | null ; enableShowSalesforceUserAssist
?: boolean | null ; isAutoTransitionDelayed
?: boolean | null ; isCrucNotificationDisabled
?: boolean | null ; isCustomProfileAutoTransitionDelayed
?: boolean | null ; isLEXWelcomeMatDisabled
?: boolean | null ; isMeetTheAssistantDisabledInClassic
?: boolean | null ; isMeetTheAssistantDisabledInLightning
?: boolean | null ; optimizerAppEnabled
?: boolean | null } User User
Interface
Settings
: Metadata & { alternateAlohaListView
?: boolean | null ; enableAsyncRelatedLists
?: boolean | null ; enableClickjackUserPageHeaderless
?: boolean | null ; enableCollapsibleSections
?: boolean | null ; enableCollapsibleSideBar
?: boolean | null ; enableCustomObjectTruncate
?: boolean | null ; enableCustomeSideBarOnAllPages
?: boolean | null ; enableDeleteFieldHistory
?: boolean | null ; enableHoverDetails
?: boolean | null ; enableInlineEdit
?: boolean | null ; enableNewPageLayoutEditor
?: boolean | null ; enablePersonalCanvas
?: boolean | null ; enablePrintableListViews
?: boolean | null ; enableProfileCustomTabsets
?: boolean | null ; enableQuickCreate
?: boolean | null ; enableTabOrganizer
?: boolean | null } User User
Management
Settings
: Metadata & { enableCanAnswerContainUsername
?: boolean | null ; enableCanSaveUserPerm
?: boolean | null ; enableConcealPersonalInfo
?: boolean | null ; enableContactlessExternalIdentityUsers
?: boolean | null ; enableEnhancedPermsetMgmt
?: boolean | null ; enableEnhancedProfileMgmt
?: boolean | null ; enableNewProfileUI
?: boolean | null ; enableScrambleUserData
?: boolean | null ; enableUserSelfDeactivate
?: boolean | null } Users Users: { user: string [] }
Validation Validation
Rule
: Metadata & { active
: boolean ; description
?: string | null ; errorConditionFormula
: string ; errorDisplayField
?: string | null ; errorMessage
: string } Validation Validation: { errorMessage: string ; name: string }
Type declaration error: string name: string Value Value
Set
: { controllingField
?: string | null ; restricted
?: boolean | null ; valueSetDefinition
?: ValueSetValuesDefinition | null ; valueSetName
?: string | null ; valueSettings
: ValueSettings [] } Type declaration Optional controlling?: string | null Optional restricted?: boolean | null Optional value?: string | null Value Value
Set
Values
Definition
: { sorted
: boolean ; value
: CustomValue [] } Value Value: { controllingFieldValue: string [] ; valueName: string }
Type declaration controlling: string [] value: string Value Value: { masterLabel: string ; translation?: string | null }
Type declaration master: string Optional translation?: string | null Value Value
Type
Field
: { fields
: ValueTypeField [] ; foreignKeyDomain
: string [] ; isForeignKey
: boolean ; isNameField
: boolean ; minOccurs
: number ; name
: string ; picklistValues
: PicklistEntry [] ; soapType
: string ; valueRequired
: boolean } Type declaration foreign: string [] is: boolean is: boolean min: number name: string soap: string value: boolean Voice Voice
Settings
: Metadata & { enableCallDisposition
?: boolean | null ; enableVoiceCallList
?: boolean | null ; enableVoiceCallRecording
?: boolean | null ; enableVoiceCoaching
?: boolean | null ; enableVoiceConferencing
?: boolean | null ; enableVoiceLocalPresence
?: boolean | null ; enableVoiceMail
?: boolean | null ; enableVoiceMailDrop
?: boolean | null } Wave Wave
Application
: Metadata & { assetIcon
?: string | null ; description
?: string | null ; folder
: string ; masterLabel
: string ; shares
: FolderShare [] ; templateOrigin
?: string | null ; templateVersion
?: string | null } Wave Wave
Dashboard
: MetadataWithContent & { application
: string ; description
?: string | null ; masterLabel
: string ; templateAssetSourceName
?: string | null } Wave Wave
Dataflow
: MetadataWithContent & { dataflowType
?: string | null ; description
?: string | null ; masterLabel
: string } Wave Wave
Dataset
: Metadata & { application
: string ; description
?: string | null ; masterLabel
: string ; templateAssetSourceName
?: string | null } Wave Wave
Lens
: MetadataWithContent & { application
: string ; datasets
: string [] ; description
?: string | null ; masterLabel
: string ; templateAssetSourceName
?: string | null ; visualizationType
: string } Wave Wave
Recipe
: MetadataWithContent & { dataflow
: string ; masterLabel
: string ; securityPredicate
?: string | null ; targetDatasetAlias
: string } Wave Wave
Template
Bundle
: Metadata & { assetIcon
?: string | null ; assetVersion
?: number | null ; description
?: string | null ; label
: string ; templateType
: string } Wave Wave
Xmd
: Metadata & { application
?: string | null ; dataset
: string ; datasetConnector
?: string | null ; datasetFullyQualifiedName
?: string | null ; dates
: WaveXmdDate [] ; dimensions
: WaveXmdDimension [] ; measures
: WaveXmdMeasure [] ; organizations
: WaveXmdOrganization [] ; origin
?: string | null ; type
?: string | null ; waveVisualization
?: string | null } Wave Wave: { alias: string ; compact?: boolean | null ; dateFieldDay?: string | null ; dateFieldEpochDay?: string | null ; dateFieldEpochSecond?: string | null ; dateFieldFiscalMonth?: string | null ; dateFieldFiscalQuarter?: string | null ; dateFieldFiscalWeek?: string | null ; dateFieldFiscalYear?: string | null ; dateFieldFullYear?: string | null ; dateFieldHour?: string | null ; dateFieldMinute?: string | null ; dateFieldMonth?: string | null ; dateFieldQuarter?: string | null ; dateFieldSecond?: string | null ; dateFieldWeek?: string | null ; dateFieldYear?: string | null ; description?: string | null ; firstDayOfWeek: number ; fiscalMonthOffset: number ; isYearEndFiscalYear?: boolean | null ; label?: string | null ; showInExplorer?: boolean | null ; sortIndex: number ; type: string }
Type declaration alias: string Optional compact?: boolean | null Optional date?: string | null Optional date?: string | null Optional date?: string | null Optional date?: string | null Optional date?: string | null Optional date?: string | null Optional date?: string | null Optional date?: string | null Optional date?: string | null Optional date?: string | null Optional date?: string | null Optional date?: string | null Optional date?: string | null Optional date?: string | null Optional date?: string | null Optional description?: string | null first: number fiscal: number Optional is?: boolean | null Optional label?: string | null Optional show?: boolean | null sort: number type: string Wave Wave
Xmd
Dimension
: { conditionalFormatting
: WaveXmdFormattingProperty [] ; customActions
: WaveXmdDimensionCustomAction [] ; customActionsEnabled
?: boolean | null ; dateFormat
?: string | null ; description
?: string | null ; field
: string ; fullyQualifiedName
?: string | null ; imageTemplate
?: string | null ; isDerived
: boolean ; isMultiValue
?: boolean | null ; label
?: string | null ; linkTemplate
?: string | null ; linkTemplateEnabled
?: boolean | null ; linkTooltip
?: string | null ; members
: WaveXmdDimensionMember [] ; origin
?: string | null ; recordDisplayFields
: WaveXmdRecordDisplayLookup [] ; recordIdField
?: string | null ; recordOrganizationIdField
?: string | null ; salesforceActions
: WaveXmdDimensionSalesforceAction [] ; salesforceActionsEnabled
?: boolean | null ; showDetailsDefaultFieldIndex
?: number | null ; showInExplorer
?: boolean | null ; sortIndex
: number } Type declaration Optional custom?: boolean | null Optional date?: string | null Optional description?: string | null field: string Optional fully?: string | null Optional image?: string | null is: boolean Optional is?: boolean | null Optional label?: string | null Optional link?: string | null Optional link?: boolean | null Optional link?: string | null Optional origin?: string | null Optional record?: string | null Optional record?: string | null Optional salesforce?: boolean | null Optional show?: number | null Optional show?: boolean | null sort: number Wave Wave: { customActionName: string ; enabled: boolean ; icon?: string | null ; method?: string | null ; sortIndex: number ; target?: string | null ; tooltip?: string | null ; url?: string | null }
Type declaration custom: string enabled: boolean Optional icon?: string | null Optional method?: string | null sort: number Optional target?: string | null Optional tooltip?: string | null Optional url?: string | null Wave Wave: { color?: string | null ; label?: string | null ; member: string ; sortIndex: number }
Type declaration Optional color?: string | null Optional label?: string | null member: string sort: number Wave Wave: { enabled: boolean ; salesforceActionName: string ; sortIndex: number }
Type declaration enabled: boolean salesforce: string sort: number Wave Wave: { bin: string ; formatValue: string ; label: string ; sortIndex: number }
Type declaration bin: string format: string label: string sort: number Wave Wave: { formatValue: string ; operator: string ; sortIndex: number ; value: string }
Type declaration format: string operator: string sort: number value: string Wave Type declaration property: string reference: string sort: number type: string Wave Wave
Xmd
Measure
: { conditionalFormatting
: WaveXmdFormattingProperty [] ; dateFormat
?: string | null ; description
?: string | null ; field
: string ; formatCustomFormat
?: string | null ; formatDecimalDigits
?: number | null ; formatIsNegativeParens
?: boolean | null ; formatPrefix
?: string | null ; formatSuffix
?: string | null ; formatUnit
?: string | null ; formatUnitMultiplier
?: number | null ; fullyQualifiedName
?: string | null ; isDerived
: boolean ; label
?: string | null ; origin
?: string | null ; showDetailsDefaultFieldIndex
?: number | null ; showInExplorer
?: boolean | null ; sortIndex
: number } Type declaration Optional date?: string | null Optional description?: string | null field: string Optional format?: string | null Optional format?: number | null Optional format?: boolean | null Optional format?: string | null Optional format?: string | null Optional format?: string | null Optional format?: number | null Optional fully?: string | null is: boolean Optional label?: string | null Optional origin?: string | null Optional show?: number | null Optional show?: boolean | null sort: number Wave Wave: { instanceUrl: string ; label: string ; organizationIdentifier: string ; sortIndex: number }
Type declaration instance: string label: string organization: string sort: number Wave Wave: { recordDisplayField: string }
Type declaration record: string Web Web
Link
: Metadata & { availability
: string ; description
?: string | null ; displayType
: string ; encodingKey
?: string | null ; hasMenubar
?: boolean | null ; hasScrollbars
?: boolean | null ; hasToolbar
?: boolean | null ; height
?: number | null ; isResizable
?: boolean | null ; linkType
: string ; masterLabel
?: string | null ; openType
: string ; page
?: string | null ; position
?: string | null ; protected
: boolean ; requireRowSelection
?: boolean | null ; scontrol
?: string | null ; showsLocation
?: boolean | null ; showsStatus
?: boolean | null ; url
?: string | null ; width
?: number | null } Web Web: { label: string ; name: string }
Type declaration label: string name: string Web Web: { caseOrigin?: string | null ; defaultResponseTemplate?: string | null ; enableWebToCase?: boolean | null }
Type declaration Optional case?: string | null Optional default?: string | null Optional enable?: boolean | null Weighted Weighted: { sourceCategoryApiName: string ; weight: number }
Type declaration source: string weight: number Work Work
Dot
Com
Settings
: Metadata & { enableCoachingManagerGroupAccess
?: boolean | null ; enableGoalManagerGroupAccess
?: boolean | null ; enableProfileSkills
?: boolean | null ; enableProfileSkillsAddFeedPost
?: boolean | null ; enableProfileSkillsAutoSuggest
?: boolean | null ; enableProfileSkillsUsePlatform
?: boolean | null ; enableWorkBadgeDefRestrictPref
?: boolean | null ; enableWorkCalibration
?: boolean | null ; enableWorkCanvasPref
?: boolean | null ; enableWorkCertification
?: boolean | null ; enableWorkCertificationNotification
?: boolean | null ; enableWorkRewardsPref
?: boolean | null ; enableWorkThanksPref
?: boolean | null ; enableWorkUseObjectivesForGoals
?: boolean | null } Workflow Workflow: { name: string ; type: string }
Workflow Workflow
Alert
: WorkflowAction & { ccEmails
: string [] ; description
: string ; protected
: boolean ; recipients
: WorkflowEmailRecipient [] ; senderAddress
?: string | null ; senderType
?: string | null ; template
: string } Workflow Workflow: { field?: string | null ; recipient?: string | null ; type: string }
Type declaration Optional field?: string | null Optional recipient?: string | null type: string Workflow Workflow
Field
Update
: WorkflowAction & { description
?: string | null ; field
: string ; formula
?: string | null ; literalValue
?: string | null ; lookupValue
?: string | null ; lookupValueType
?: string | null ; name
: string ; notifyAssignee
: boolean ; operation
: string ; protected
: boolean ; reevaluateOnChange
?: boolean | null ; targetObject
?: string | null } Workflow Workflow: { name: string ; value?: string | null }
Type declaration name: string Optional value?: string | null Workflow Workflow
Knowledge
Publish
: WorkflowAction & { action
: string ; description
?: string | null ; label
: string ; language
?: string | null ; protected
: boolean } Workflow Workflow
Outbound
Message
: WorkflowAction & { apiVersion
: number ; description
?: string | null ; endpointUrl
: string ; fields
: string [] ; includeSessionId
: boolean ; integrationUser
: string ; name
: string ; protected
: boolean ; useDeadLetterQueue
?: boolean | null } Workflow Workflow
Send
: WorkflowAction & { action
: string ; description
?: string | null ; label
: string ; language
?: string | null ; protected
: boolean } Workflow Workflow
Task
: WorkflowAction & { assignedTo
?: string | null ; assignedToType
: string ; description
?: string | null ; dueDateOffset
: number ; notifyAssignee
: boolean ; offsetFromField
?: string | null ; priority
: string ; protected
: boolean ; status
: string ; subject
: string } Workflow Workflow: { description?: string | null ; name: string ; subject?: string | null }
Type declaration Optional description?: string | null name: string Optional subject?: string | null Workflow Workflow
Time
Trigger
: { actions
: WorkflowActionReference [] ; offsetFromField
?: string | null ; timeLength
?: string | null ; workflowTimeTriggerUnit
: string } Type declaration Optional offset?: string | null Optional time?: string | null workflow: string Workspace Workspace: { fieldName?: string | null ; tab: string }
Type declaration Optional field?: string | null tab: string
This file is generated from WSDL file by wsdl2schema.ts. Do not modify directly. To generate the file, run "ts-node path/to/wsdl2schema.ts path/to/wsdl.xml path/to/schema.ts"